Class DeityInvokeMilestoneModifierInstance`Abstract`

Hierarchy

MilestoneModifierInstance
- DeityInvokeMilestoneModifierInstance

Index

Constructors

constructor

new DeityInvokeMilestoneModifierInstance(id: Milestone, random: Random<IRandomGenerator<any>>, ...args: [default<unknown, number, NPC | Player>?]): DeityInvokeMilestoneModifierInstance
Parameters
- id: Milestone
- random: Random<IRandomGenerator<any>>
- Rest ...args: [default<unknown, number, NPC | Player>?]
Returns DeityInvokeMilestoneModifierInstance
Inherited from MilestoneModifierInstance.constructor
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:35

Properties

`Protected` `Readonly` args

args: [default<unknown, number, NPC | Player>?]

`Readonly` event

event: IEventEmitter<DeityInvokeMilestoneModifierInstance, IGameplayModifierInstanceEvents>

`Readonly` id

id: Milestone

options

options: IGameOptionsPartial = {}

`Readonly` random

random: Random<IRandomGenerator<any>>

Accessors

`Protected` player

get player(): undefined | default<unknown, number, NPC | Player>
Returns undefined | default<unknown, number, NPC | Player>
Inherited from MilestoneModifierInstance.player
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:56

Methods

addOptions

addOptions(options: IGameOptionsPartial): DeityInvokeMilestoneModifierInstance
Parameters
- options: IGameOptionsPartial
Returns DeityInvokeMilestoneModifierInstance
Inherited from MilestoneModifierInstance.addOptions
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:48

`Protected` `Abstract` apply

apply(): void
Returns void
- Defined in src/game/game/options/modifiers/milestone/modifiers/shared/DeityInvokeMilestoneModifier.ts:35

clearData

clearData(): DeityInvokeMilestoneModifierInstance
Returns DeityInvokeMilestoneModifierInstance
Inherited from MilestoneModifierInstance.clearData
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:81

`Protected` `Abstract` getChance

getChance(): number
Returns number
- Defined in src/game/game/options/modifiers/milestone/modifiers/shared/DeityInvokeMilestoneModifier.ts:34

getData

getData(): any
Returns any
Inherited from MilestoneModifierInstance.getData
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:67

`Protected` getDefaultTitle

getDefaultTitle(): default
Returns default
Inherited from MilestoneModifierInstance.getDefaultTitle
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:65

getTitle

getTitle(): default
Returns default
Inherited from MilestoneModifierInstance.getTitle
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:55

`Optional` initialize

initialize(): void
Returns void
Inherited from MilestoneModifierInstance.initialize
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:86

isEnabledForPlayer

isEnabledForPlayer(entity: default<unknown, number, EntityReferenceTypes, unknown>): boolean
Parameters
- entity: default<unknown, number, EntityReferenceTypes, unknown>
Returns boolean
Inherited from MilestoneModifierInstance.isEnabledForPlayer
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:60

`Protected` onTickEnd

onTickEnd(): void
Returns void
- Defined in src/game/game/options/modifiers/milestone/modifiers/shared/DeityInvokeMilestoneModifier.ts:37

setData

setData(data?: any): DeityInvokeMilestoneModifierInstance
Parameters
- Optional data: any
Returns DeityInvokeMilestoneModifierInstance
Inherited from MilestoneModifierInstance.setData
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:71

setOptions

setOptions(options: IGameOptionsPartial): DeityInvokeMilestoneModifierInstance
Parameters
- options: IGameOptionsPartial
Returns DeityInvokeMilestoneModifierInstance
Inherited from MilestoneModifierInstance.setOptions
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:42

setTitle

setTitle(initializer: ((defaultTitle: default) => default)): DeityInvokeMilestoneModifierInstance
Parameters
- initializer: ((defaultTitle: default) => default)
  - - (defaultTitle: default): default
    - Parameters
      
      defaultTitle: default
      
      Returns default
Returns DeityInvokeMilestoneModifierInstance
Inherited from MilestoneModifierInstance.setTitle
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:62

`Optional` uninitialize

uninitialize(): void
Returns void
Inherited from MilestoneModifierInstance.uninitialize
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:87

Class DeityInvokeMilestoneModifierInstanceAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: Milestone

random: Random<IRandomGenerator<any>>

Rest ...args: [default<unknown, number, NPC | Player>?]

Returns DeityInvokeMilestoneModifierInstance

Properties

Protected Readonly args

Readonly event

Readonly id

options

Readonly random

Accessors

Protected player

Returns undefined | default<unknown, number, NPC | Player>

Methods

addOptions

Parameters

options: IGameOptionsPartial

Returns DeityInvokeMilestoneModifierInstance

Protected Abstract apply

Returns void

clearData

Returns DeityInvokeMilestoneModifierInstance

Protected Abstract getChance

Returns number

getData

Returns any

Protected getDefaultTitle

Returns default

getTitle

Returns default

Optional initialize

Returns void

isEnabledForPlayer

Parameters

entity: default<unknown, number, EntityReferenceTypes, unknown>

Returns boolean

Protected onTickEnd

Returns void

setData

Parameters

Optional data: any

Returns DeityInvokeMilestoneModifierInstance

setOptions

Parameters

options: IGameOptionsPartial

Returns DeityInvokeMilestoneModifierInstance

setTitle

Parameters

initializer: ((defaultTitle: default) => default)

Parameters

defaultTitle: default

Returns default

Returns DeityInvokeMilestoneModifierInstance

Optional uninitialize

Returns void

Settings

Member Visibility

Theme

Class DeityInvokeMilestoneModifierInstance`Abstract`

`Rest` ...args: [default<unknown, number, NPC | Player>?]

`Protected` `Readonly` args

`Readonly` event

`Readonly` id

`Readonly` random

`Protected` player

`Protected` `Abstract` apply

`Protected` `Abstract` getChance

`Protected` getDefaultTitle

`Optional` initialize

`Protected` onTickEnd

`Optional` data: any

`Optional` uninitialize