Class UsableActionTranslator

Hierarchy

UsableActionTranslator

Index

Constructors

constructor

Properties

Methods

addArgs description get name useAny useByType useByTypeAndQuality useExact translateId

Constructors

constructor

new UsableActionTranslator(id: ActionId): UsableActionTranslator
Parameters
- id: ActionId
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:56

Properties

`Readonly` id

id: ActionId

Methods

addArgs

addArgs(...args: (undefined | null | string | number | boolean | default | ISerializedTranslation | IStringSection | TranslationArg[] | ITranslationArgRecord | Supplier<TranslationArg, UsableActionTranslationArguments>)[]): UsableActionTranslator
Parameters
- Rest ...args: (undefined | null | string | number | boolean | default | ISerializedTranslation | IStringSection | TranslationArg[] | ITranslationArgRecord | Supplier<TranslationArg, UsableActionTranslationArguments>)[]
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:67

description

description(id: ActionId): UsableActionTranslator
Parameters
- id: ActionId
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:72
description(supplier: SupplierOr<default, UsableActionTranslationArguments>): UsableActionTranslator
Parameters
- supplier: SupplierOr<default, UsableActionTranslationArguments>
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:73

get

get(action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>, using?: IUsableActionPossibleUsing, which?: ActionWhichTranslation, context?: UsableActionDisplayContext, inspectionContext?: InfoProviderContext): undefined | default
Parameters
- action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>
- using: IUsableActionPossibleUsing = {}
- which: ActionWhichTranslation = ActionTranslation.Name
- context: UsableActionDisplayContext = UsableActionDisplayContext.Use
- Optional inspectionContext: InfoProviderContext
Returns undefined | default
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:99

name

name(id: ActionId): UsableActionTranslator
Parameters
- id: ActionId
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:60
name(supplier: SupplierOr<default, UsableActionTranslationArguments>): UsableActionTranslator
Parameters
- supplier: SupplierOr<default, UsableActionTranslationArguments>
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:61

useAny

useAny(supplier: SupplierOr<default, UsableActionTranslationArguments>): UsableActionTranslator
Parameters
- supplier: SupplierOr<default, UsableActionTranslationArguments>
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:94

useByType

useByType(supplier: SupplierOr<default, UsableActionTranslationArguments>): UsableActionTranslator
Parameters
- supplier: SupplierOr<default, UsableActionTranslationArguments>
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:89

useByTypeAndQuality

useByTypeAndQuality(supplier: SupplierOr<default, UsableActionTranslationArguments>): UsableActionTranslator
Parameters
- supplier: SupplierOr<default, UsableActionTranslationArguments>
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:84

useExact

useExact(supplier: SupplierOr<default, UsableActionTranslationArguments>): UsableActionTranslator
Parameters
- supplier: SupplierOr<default, UsableActionTranslationArguments>
Returns UsableActionTranslator
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:79

`Static` translateId

translateId(id: ActionId, which?: ActionTranslation): undefined | default
Parameters
- id: ActionId
- which: ActionTranslation = ActionTranslation.Name
Returns undefined | default
- Defined in src/game/game/entity/action/usable/UsableActionTranslator.ts:32

Class UsableActionTranslator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: ActionId

Returns UsableActionTranslator

Properties

Readonly id

Methods

addArgs

Parameters

Rest ...args: (undefined | null | string | number | boolean | default | ISerializedTranslation | IStringSection | TranslationArg[] | ITranslationArgRecord | Supplier<TranslationArg, UsableActionTranslationArguments>)[]

Returns UsableActionTranslator

description

Parameters

id: ActionId

Returns UsableActionTranslator

Parameters

supplier: SupplierOr<default, UsableActionTranslationArguments>

Returns UsableActionTranslator

get

Parameters

action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>

using: IUsableActionPossibleUsing = {}

which: ActionWhichTranslation = ActionTranslation.Name

context: UsableActionDisplayContext = UsableActionDisplayContext.Use

Optional inspectionContext: InfoProviderContext

Returns undefined | default

name

Parameters

id: ActionId

Returns UsableActionTranslator

Parameters

supplier: SupplierOr<default, UsableActionTranslationArguments>

Returns UsableActionTranslator

useAny

Parameters

supplier: SupplierOr<default, UsableActionTranslationArguments>

Returns UsableActionTranslator

useByType

Parameters

supplier: SupplierOr<default, UsableActionTranslationArguments>

Returns UsableActionTranslator

useByTypeAndQuality

Parameters

supplier: SupplierOr<default, UsableActionTranslationArguments>

Returns UsableActionTranslator

useExact

Parameters

supplier: SupplierOr<default, UsableActionTranslationArguments>

Returns UsableActionTranslator

Static translateId

Parameters

id: ActionId

which: ActionTranslation = ActionTranslation.Name

Returns undefined | default

Settings

Member Visibility

Theme

`Readonly` id

`Rest` ...args: (undefined | null | string | number | boolean | default | ISerializedTranslation | IStringSection | TranslationArg[] | ITranslationArgRecord | Supplier<TranslationArg, UsableActionTranslationArguments>)[]

`Optional` inspectionContext: InfoProviderContext

`Static` translateId