Class default<DEFINITION, REQUIREMENTS>

Type Parameters

DEFINITION extends IUsableActionDynamicDefinition
REQUIREMENTS extends IUsableActionRequirements

Hierarchy

UsableActionGenerator
- default

Index

Constructors

constructor

new default<DEFINITION, REQUIREMENTS>(config: IUsableActionsDynamicConfig<DEFINITION, REQUIREMENTS>): default<DEFINITION, REQUIREMENTS>
Type Parameters
- DEFINITION extends IUsableActionDynamicDefinition
- REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS>
Parameters
- config: IUsableActionsDynamicConfig<DEFINITION, REQUIREMENTS>
Returns default<DEFINITION, REQUIREMENTS>
Overrides UsableActionGenerator.constructor
- Defined in src/game/game/entity/action/usable/actions/UsableActionsDynamic.ts:61

Properties

`Readonly` event

event: IEventEmitter<default<DEFINITION, REQUIREMENTS>, IUsableActionGeneratorEvents>

Methods

add

add(registrationHandler: UsableActionGeneratorRegistrationHandler<[]>): default<DEFINITION, REQUIREMENTS>
Parameters
- registrationHandler: UsableActionGeneratorRegistrationHandler<[]>
Returns default<DEFINITION, REQUIREMENTS>
Inherited from UsableActionGenerator.add
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:322
add(generator: UsableActionGenerator<[]>): default<DEFINITION, REQUIREMENTS>
Parameters
- generator: UsableActionGenerator<[]>
Returns default<DEFINITION, REQUIREMENTS>
Inherited from UsableActionGenerator.add
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:323

disablePersistence

disablePersistence(): void
Removes persistence from this generator. All prior "when" and "until" persistence ranges will be removed.

Returns void
Inherited from UsableActionGenerator.disablePersistence
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:466

get

get(...args: []): default
Returns an action registrar created by this generator. If there is not a cached registrar, generates a new one.
Does not cache the generator unless this generator is marked for persistence.
Parameters
- Rest ...args: []
Returns default
Inherited from UsableActionGenerator.get
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:372

persist

persist(initializer: ((persist: IUsableActionGeneratorPersistenceFactory<default<DEFINITION, REQUIREMENTS>>) => default<DEFINITION, REQUIREMENTS>)): default<DEFINITION, REQUIREMENTS>
Marks this generator for persistence when the "when" event occurs, and unmarks this generator for persistence when the "until" event occurs.

This method can be called multiple times to add multiple ranges where persistence is active. Intersecting persistences don't cancel each other.
Parameters
- initializer: ((persist: IUsableActionGeneratorPersistenceFactory<default<DEFINITION, REQUIREMENTS>>) => default<DEFINITION, REQUIREMENTS>)
  - - (persist: IUsableActionGeneratorPersistenceFactory<default<DEFINITION, REQUIREMENTS>>): default<DEFINITION, REQUIREMENTS>
    - Parameters
      
      persist: IUsableActionGeneratorPersistenceFactory<default<DEFINITION, REQUIREMENTS>>
      
      Returns default<DEFINITION, REQUIREMENTS>
Returns default<DEFINITION, REQUIREMENTS>
Inherited from UsableActionGenerator.persist
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:416

register

register(registrar: default, ...args: []): void
Parameters
- registrar: default
- Rest ...args: []
Returns void
Inherited from UsableActionGenerator.register
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:350

remove

remove(registrationHandler: UsableActionGeneratorRegistrationHandler<[]>): default<DEFINITION, REQUIREMENTS>
Parameters
- registrationHandler: UsableActionGeneratorRegistrationHandler<[]>
Returns default<DEFINITION, REQUIREMENTS>
Inherited from UsableActionGenerator.remove
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:334
remove(generator: UsableActionGenerator<[]>): default<DEFINITION, REQUIREMENTS>
Parameters
- generator: UsableActionGenerator<[]>
Returns default<DEFINITION, REQUIREMENTS>
Inherited from UsableActionGenerator.remove
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:335

setContextMenuInitializer

setContextMenuInitializer(initializer?: ((menu: default<string | number | symbol>) => any)): default<DEFINITION, REQUIREMENTS>
Initializes any context menus originating from registrars generated by this generator. Note: Overrides any initializers set by default on the registration handler.
Parameters
- Optional initializer: ((menu: default<string | number | symbol>) => any)
  - - (menu: default<string | number | symbol>): any
    - Parameters
      
      menu: default<string | number | symbol>
      
      Returns any
Returns default<DEFINITION, REQUIREMENTS>
Inherited from UsableActionGenerator.setContextMenuInitializer
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:361

`Static` persisting

persisting(initializer: ((persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => IUsableActionGeneratorFactory)): IUsableActionGeneratorFactory
Parameters
- initializer: ((persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => IUsableActionGeneratorFactory)
  - - (persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>): IUsableActionGeneratorFactory
    - Parameters
      
      persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>
      
      Returns IUsableActionGeneratorFactory
Returns IUsableActionGeneratorFactory
Inherited from UsableActionGenerator.persisting
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:266
persisting(initializer: ((persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => UsableActionGenerator<[]>)): UsableActionGenerator<[]>
Parameters
- initializer: ((persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => UsableActionGenerator<[]>)
  - - (persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>): UsableActionGenerator<[]>
    - Parameters
      
      persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>
      
      Returns UsableActionGenerator<[]>
Returns UsableActionGenerator<[]>
Inherited from UsableActionGenerator.persisting
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:267

`Static` singleton

singleton<REQUIREMENTS>(id: string | number, action: default<REQUIREMENTS, IUsableActionDefinition<REQUIREMENTS>>): UsableActionGenerator<[]>
Type Parameters
- REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS>
Parameters
- id: string | number
- action: default<REQUIREMENTS, IUsableActionDefinition<REQUIREMENTS>>
Returns UsableActionGenerator<[]>
Inherited from UsableActionGenerator.singleton
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:299

Class default<DEFINITION, REQUIREMENTS>

Type Parameters

DEFINITION extends IUsableActionDynamicDefinition

REQUIREMENTS extends IUsableActionRequirements

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

DEFINITION extends IUsableActionDynamicDefinition

REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS>

Parameters

config: IUsableActionsDynamicConfig<DEFINITION, REQUIREMENTS>

Returns default<DEFINITION, REQUIREMENTS>

Properties

Readonly event

Methods

add

Parameters

registrationHandler: UsableActionGeneratorRegistrationHandler<[]>

Returns default<DEFINITION, REQUIREMENTS>

Parameters

generator: UsableActionGenerator<[]>

Returns default<DEFINITION, REQUIREMENTS>

disablePersistence

Returns void

get

Parameters

Rest ...args: []

Returns default

persist

Parameters

initializer: ((persist: IUsableActionGeneratorPersistenceFactory<default<DEFINITION, REQUIREMENTS>>) => default<DEFINITION, REQUIREMENTS>)

Parameters

persist: IUsableActionGeneratorPersistenceFactory<default<DEFINITION, REQUIREMENTS>>

Returns default<DEFINITION, REQUIREMENTS>

Returns default<DEFINITION, REQUIREMENTS>

register

Parameters

registrar: default

Rest ...args: []

Returns void

remove

Parameters

registrationHandler: UsableActionGeneratorRegistrationHandler<[]>

Returns default<DEFINITION, REQUIREMENTS>

Parameters

generator: UsableActionGenerator<[]>

Returns default<DEFINITION, REQUIREMENTS>

setContextMenuInitializer

Parameters

Optional initializer: ((menu: default<string | number | symbol>) => any)

Parameters

menu: default<string | number | symbol>

Returns any

Returns default<DEFINITION, REQUIREMENTS>

Static persisting

Parameters

initializer: ((persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => IUsableActionGeneratorFactory)

Parameters

persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>

Returns IUsableActionGeneratorFactory

Returns IUsableActionGeneratorFactory

Parameters

initializer: ((persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => UsableActionGenerator<[]>)

Parameters

persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>

Returns UsableActionGenerator<[]>

Returns UsableActionGenerator<[]>

Static singleton

Type Parameters

REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS>

Parameters

id: string | number

action: default<REQUIREMENTS, IUsableActionDefinition<REQUIREMENTS>>

Returns UsableActionGenerator<[]>

Settings

`Readonly` event

`Rest` ...args: []

`Rest` ...args: []

`Optional` initializer: ((menu: default<string | number | symbol>) => any)

`Static` persisting

`Static` singleton