Class LevelConditions

等级条件

Hierarchy (View Summary)

Conditions
- LevelConditions

Index

Constructors

Properties

consumeAmount level

Methods

check getFailedReason getTextProvider

Constructors

constructor

new LevelConditions(level: number, consumeAmount?: boolean): LevelConditions
Parameters
- level: number
  满足条件所需的最低等级
- consumeAmount: boolean = false
  倘若为true，则条件检查通过后会自动消耗对应等级
Returns LevelConditions
Overrides Conditions.constructor
- Defined in packages/condition/src/api/LevelConditions.ts:12

Properties

`Protected`consumeAmount

consumeAmount: boolean = false

倘若为true，则条件检查通过后会自动消耗对应等级

`Protected`level

level: number

满足条件所需的最低等级

Methods

check

check(player: Player, visual?: boolean): boolean
检查玩家是否满足条件
Parameters
- player: Player
  要检查的玩家对象
- visual: boolean = false
  将这次检查设置为虚拟检查，不会消耗条件对应游戏元素的数量
Returns boolean
如果玩家满足条件返回true，否则返回false
Overrides Conditions.check
- Defined in packages/condition/src/api/LevelConditions.ts:18

getFailedReason

getFailedReason(): RawMessage
获取条件检查失败时的原因说明文本

Returns RawMessage
用于显示失败原因的文本
Overrides Conditions.getFailedReason
- Defined in packages/condition/src/api/LevelConditions.ts:38

getTextProvider

getTextProvider(): RawMessage
获取条件的文本，该文本将会在任务面板中显示

Returns RawMessage
用于显示条件描述的文本
Overrides Conditions.getTextProvider
- Defined in packages/condition/src/api/LevelConditions.ts:27