TheGods 神煞宜忌类

WaterbesideAbout 3 min

TheGods 神煞宜忌类

theGods插件
属性或方法描述参数返回类型
lsr当前Lunisolar对象实例Lunisolar
getGods(ymdh)取得神煞参数默认为"MD", 可以是 "Y","M": "D": "H"的任一个或多个字符的组合,返回其对应的年神、月神、日神、时神或其组合God[]
getGoodGods(ymdh)取得吉神参数默认为"MD", 参数同上God[]
getBadGods(ymdh)取得凶神参数默认为"MD", 参数同上God[]
getDuty12God()取得当日建除十二神(建、除、满...)God
getLife12God(ymdh)取得长生十二神(长生、沐浴、冠帶...)参数可以是 "year"、"month"、"day"、 "hour"的其中一个God
getActs(actType, returnKey, replacer)取得当日宜忌actType: 0 | 1 | 2 | 3
指返回宜忌的分类
returnKey: boolean
是否返回宜忌的key,默认为false, 即返回国际化翻译后的宜忌
replacer: { [key: string]: string }
用于替换宜忌词条的字典对象
{good: string[], bad: string[]}
getGoodActs(actType, returnKey, replacer)取得当日所宜参数与 getActs 方法一致string[]
getBadActs(actType, returnKey, replacer)取得当日所忌参数与 getActs 方法一致string[]
getAllDayHourGods()取得整日各时辰的神煞God[][]
getLuckHours(luckType)取得整日各时辰的吉凶luckeType: 0 | 1
0: 按黄黑道十二神(即青龙明堂等)决定吉凶
1:根据时辰的吉神凶神个数决定吉凶
number[]
getAllLuckDirection()取得当日所有神煞吉方,将会返回元素为 **[二十四山对象, 神煞对象]**元组的列表[Direction24, God][]
getLuckDirection(godKeyOrName)取得指定吉神所在方位,将会返回 **[二十四山对象, 神煞对象]**元组godKeyOrName: string
吉方神煞名称,一般为 '喜神' | '福神' | '財神' | '陽貴' | '陰貴'
[Direction24, God]
query(queryString)通过输入查询语句进行通用查询query: stringGod | God[] | string[] | null

queryString说明:

queryString 存入的字符串,对应返回的内容参见下表, 其中zh的中文字条取决于你是否使用zh语言名才能使用该字条。故建议使用key中的字条存入存数。

keyzh说明返回类型
year gods年神取得年神God[]
month gods月神取得月神God[]
day gods日神取得日神God[]
hour gods時神取得時神God[]
this day gods本日神煞取得本日神煞God[]
day of yellow-black god本日黃黑十二神取得本日的串宫十二神God[]
hour of yellow-black god此時黃黑十二神取得此时辰的串宫十二神God[]
duty god建除十二神取得建除God
year of long-life god年長生十二神取得年长生十二神God
month of long-life god月長生十二神取得月长生十二神God
day of long-life god日長生十二神取得日长生十二神God
hour of long-life god時長生十二神取得时辰长生十二神God
good act取得本日所宜string[]
good act 1宜1取得本日通书所宜string[]
good act 2宜2取得本日御用所宜string[]
good act 3宜3取得本日民用所宜string[]
bad act取得本日所忌string[]
bad act 1忌1取得本日通书所忌string[]
bad act 2忌2取得本日御用所忌string[]
bad act 3忌3取得本日民用所忌string[]