Class PersistentModifier`Abstract`

Index

Constructors

Properties

stackCount type virtualStackCount

Methods

add apply clone getArgs getIcon getIconStackText getMaxStackCount getStackCount incrementStack isIconVisible match shouldApply

Constructors

constructor

new PersistentModifier(type, stackCount?): PersistentModifier
Parameters
- type: ModifierType
- OptionalstackCount: number
Returns PersistentModifier
Overrides Modifier.constructor
- Defined in src/modifier/modifier.ts:168

Properties

stackCount

stackCount: number

type

type: ModifierType

virtualStackCount

virtualStackCount: number

Methods

add

add(modifiers, virtual): boolean
Parameters
- modifiers: PersistentModifier[]
- virtual: boolean
Returns boolean
- Defined in src/modifier/modifier.ts:174

`Abstract`apply

apply(...args): boolean | Promise<boolean>
Handles applying of Modifier
Parameters
- Rest...args: unknown[]
  collection of all passed parameters
Returns boolean | Promise<boolean>
Inherited from Modifier.apply
- Defined in src/modifier/modifier.ts:161

`Abstract`clone

clone(): PersistentModifier
Returns PersistentModifier
- Defined in src/modifier/modifier.ts:189

getArgs

getArgs(): any[]
Returns any[]
- Defined in src/modifier/modifier.ts:191

getIcon

getIcon(forSummary?): Container
Parameters
- OptionalforSummary: boolean
Returns Container
- Defined in src/modifier/modifier.ts:218

getIconStackText

getIconStackText(virtual?): null | BitmapText
Parameters
- Optionalvirtual: boolean
Returns null | BitmapText
- Defined in src/modifier/modifier.ts:239

`Abstract`getMaxStackCount

getMaxStackCount(forThreshold?): number
Parameters
- OptionalforThreshold: boolean
Returns number
- Defined in src/modifier/modifier.ts:212

getStackCount

getStackCount(): number
Returns number
- Defined in src/modifier/modifier.ts:208

incrementStack

incrementStack(amount, virtual): boolean
Parameters
- amount: number
- virtual: boolean
Returns boolean
- Defined in src/modifier/modifier.ts:195

isIconVisible

isIconVisible(): boolean
Returns boolean
- Defined in src/modifier/modifier.ts:214

match

match(_modifier): boolean
Parameters
- _modifier: Modifier
Returns boolean
Inherited from Modifier.match
- Defined in src/modifier/modifier.ts:144

shouldApply

shouldApply(..._args): boolean
Checks if Modifier should be applied
Parameters
- Rest..._args: unknown[]
  parameters passed to Modifier.apply
Returns boolean
always true by default
Inherited from Modifier.shouldApply
- Defined in src/modifier/modifier.ts:153