Class default

Hierarchy

default

Implements

Omit<ISerializable, "deserializeObject">

Constructors

constructor

new default(dictionary: string | default, entry: string | number, index?: number | "random"): default
Parameters
- dictionary: string | default
- entry: string | number
- Optional index: number | "random"
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:241
new default(translationId: string): default
Parameters
- translationId: string
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:242

Properties

`Readonly` args

args: TranslationArg[] = []

`Readonly` id

id: string

`Readonly` isValid

isValid: boolean

`Readonly` reformatters

reformatters: [reformatter: default, ...args: TranslationArg[]][] = []

`Static` sectionStringRenderers

sectionStringRenderers: TranslationStringRenderer[] = []

Accessors

context

get context(): TextContext
Returns TextContext
- Defined in src/game/language/impl/TranslationImpl.ts:224

`Static` config

get config(): undefined | ITranslationConfig
Returns undefined | ITranslationConfig
- Defined in src/game/language/impl/TranslationImpl.ts:67
set config(config: undefined | ITranslationConfig): void
Parameters
- config: undefined | ITranslationConfig
Returns void
- Defined in src/game/language/impl/TranslationImpl.ts:61

Methods

addArgs

addArgs(...args: TranslationArg[]): default
Parameters
- Rest ...args: TranslationArg[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:382

classed

classed(...classes: (string | Supplier<undefined | string, []>)[]): default
Parameters
- Rest ...classes: (string | Supplier<undefined | string, []>)[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:315

clone

clone(): default
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:275

equals

equals(translation: default): boolean
Parameters
- translation: default
Returns boolean
- Defined in src/game/language/impl/TranslationImpl.ts:266

get

get(...args: any[]): IStringSection[]
Returns this translation as a list of string sections
Parameters
- Rest ...args: any[]
Returns IStringSection[]
- Defined in src/game/language/impl/TranslationImpl.ts:477

getDictionary

getDictionary(): default
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:262

getReference

getReference(): undefined | Reference
Returns undefined | Reference
- Defined in src/game/language/impl/TranslationImpl.ts:366

getReferenceContext

getReferenceContext(): undefined | InfoProviderContext
Returns undefined | InfoProviderContext
- Defined in src/game/language/impl/TranslationImpl.ts:370

getString

getString(...args: any[]): string
Returns the translation as a string
Parameters
- Rest ...args: any[]
Returns string
- Defined in src/game/language/impl/TranslationImpl.ts:507

hasFailWith

hasFailWith(notEmptyString?: boolean): boolean
Returns true if this translation has been set to fail with another translation or string.
Parameters
- notEmptyString: boolean = false
Returns boolean
- Defined in src/game/language/impl/TranslationImpl.ts:441

hasTranslation

hasTranslation(): boolean
Returns boolean
- Defined in src/game/language/impl/TranslationImpl.ts:460

inContext

inContext(context?: TextContext, normalize?: boolean): default
Parameters
- context: TextContext = TextContext.None
- normalize: boolean = false
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:390

orElse

orElse(translation?: GetterOfOr<undefined | default>): undefined | default
Parameters
- Optional translation: GetterOfOr<undefined | default>
Returns undefined | default
- Defined in src/game/language/impl/TranslationImpl.ts:470

passTo

passTo(reformatters: ArrayOr<Reformatter>, ...args: TranslationArg[]): default
Parameters
- reformatters: ArrayOr<Reformatter>
- Rest ...args: TranslationArg[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:397
passTo(beginning: true, reformatters: ArrayOr<Reformatter>, ...args: TranslationArg[]): default
Parameters
- beginning: true
- reformatters: ArrayOr<Reformatter>
- Rest ...args: TranslationArg[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:398

serialize

serialize(depth?: number): ISerializedTranslation
Parameters
- depth: number = 0
Returns ISerializedTranslation
- Defined in src/game/language/impl/TranslationImpl.ts:553

serializeObject

serializeObject(): ISerializedTranslation
Returns ISerializedTranslation
Implementation of Omit.serializeObject
- Defined in src/game/language/impl/TranslationImpl.ts:548

setFailWith

setFailWith(failWith?: string | default | IStringSection[]): default
Sets what this translation will return if there is no translation.
Parameters
- Optional failWith: string | default | IStringSection[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:431

setRandom

setRandom(random?: Random<IRandomGenerator<any>>): default
Sets the random source for this Translation. Uses general random by default, not seeded.

Note: If this translation is an argument to another translation, it will use the random of the parent translation.
Parameters
- random: Random<IRandomGenerator<any>> = generalRandom
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:450

setReference

setReference(reference?: Reference | Referenceable, context?: InfoProviderContext, forceInclude?: true): default
Parameters
- Optional reference: Reference | Referenceable
- Optional context: InfoProviderContext
- Optional forceInclude: true
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:374

setWhich

setWhich(which?: number | "random"): default
Parameters
- which: number | "random" = 0
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:270

subscribeRefreshOn

subscribeRefreshOn<E, K>(emitterOrBus: undefined | E, ...args: [...events: K[], predicate: ((...params: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any, undefined>;
    11(): Game;
    12(): default<unknown, number, NPC | Player>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): default;
    21(): MilestoneManager;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default;
    28(): default.Events;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): default;
    34(): Ui;
    35(): default;
    36(): default;
    37(): default;
    38(): default;
    39(): default;
    4(): default;
    40(): default;
    41(): default;
    42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
    43(): WorldRenderer;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, EntityReferenceTypes, unknown>;
    9(): default<unknown, number, EntityReferenceTypes, unknown>;
}[E]> : E>, ...args: Extract<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any, undefined>;
    11(): Game;
    12(): default<unknown, number, NPC | Player>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): default;
    21(): MilestoneManager;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default;
    28(): default.Events;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): default;
    34(): Ui;
    35(): default;
    36(): default;
    37(): default;
    38(): default;
    39(): default;
    4(): default;
    40(): default;
    41(): default;
    42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
    43(): WorldRenderer;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, EntityReferenceTypes, unknown>;
    9(): default<unknown, number, EntityReferenceTypes, unknown>;
}[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>, any[]>[]]) => boolean)]): default
Marks this translation as to be refreshed on events for the given host. The text renderer is responsible for actually handling refreshes.

Note: This cannot be serialized!
Type Parameters
- E extends GameEmitterOrBus
- K extends string | number | symbol
Parameters
- emitterOrBus: undefined | E
- Rest ...args: [...events: K[], predicate: ((...params: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any, undefined>;
      11(): Game;
      12(): default<unknown, number, NPC | Player>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): default;
      21(): MilestoneManager;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default;
      28(): default.Events;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): default;
      34(): Ui;
      35(): default;
      36(): default;
      37(): default;
      38(): default;
      39(): default;
      4(): default;
      40(): default;
      41(): default;
      42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
      43(): WorldRenderer;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, EntityReferenceTypes, unknown>;
      9(): default<unknown, number, EntityReferenceTypes, unknown>;
  }[E]> : E>, ...args: Extract<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any, undefined>;
      11(): Game;
      12(): default<unknown, number, NPC | Player>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): default;
      21(): MilestoneManager;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default;
      28(): default.Events;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): default;
      34(): Ui;
      35(): default;
      36(): default;
      37(): default;
      38(): default;
      39(): default;
      4(): default;
      40(): default;
      41(): default;
      42(): default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>;
      43(): WorldRenderer;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, EntityReferenceTypes, unknown>;
      9(): default<unknown, number, EntityReferenceTypes, unknown>;
  }[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>, any[]>[]]) => boolean)]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:339
subscribeRefreshOn<E, K>(emitterOrBus: undefined | E, ...events: K[]): default
Marks this translation as to be refreshed on events for the given host. The text renderer is responsible for actually handling refreshes.

Note: This cannot be serialized!
Type Parameters
- E extends GameEmitterOrBus
- K extends string | number | symbol
Parameters
- emitterOrBus: undefined | E
- Rest ...events: K[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:346

toString

toString(): string
Returns string
- Defined in src/game/language/impl/TranslationImpl.ts:526

withSegments

withSegments(...segments: ISegment[]): default
Parameters
- Rest ...segments: ISegment[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:297
withSegments(priority: true, ...segments: ISegment[]): default
Parameters
- priority: true
- Rest ...segments: ISegment[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:298

withTooltip

withTooltip(tooltip?: default | IStringSection[] | ((tooltip: default) => any) | Falsy, wide?: true): default
Parameters
- Optional tooltip: default | IStringSection[] | ((tooltip: default) => any) | Falsy
- Optional wide: true
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:321

`Static` deserialize

deserialize(serializedTranslation: ISerializedTranslation): default
Parameters
- serializedTranslation: ISerializedTranslation
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:137

`Static` generator

generator(textOrGenerator: GetterOfOr<string | IStringSection[]>, link?: Link): TranslationGenerator
DO NOT USE THIS METHOD

Unless the text is PRE-GENERATED and there is NO WAY TO TRANSLATE IT.

Example uses include text the user inputs, and text from other sites (steam/trello)
Parameters
- textOrGenerator: GetterOfOr<string | IStringSection[]>
- Optional link: Link
Returns TranslationGenerator
- Defined in src/game/language/impl/TranslationImpl.ts:198

`Static` getAll

getAll(dictionary: string | default, entry?: string | number): default[]
Parameters
- dictionary: string | default
- Optional entry: string | number
Returns default[]
- Defined in src/game/language/impl/TranslationImpl.ts:71

`Static` getString

getString(sections: ArrayOfIterablesOr<string | default | IStringSection>): string
Parameters
- sections: ArrayOfIterablesOr<string | default | IStringSection>
Returns string
- Defined in src/game/language/impl/TranslationImpl.ts:94

`Static` isSerializedTranslation

isSerializedTranslation(thing: unknown): thing is ISerializedTranslation
Parameters
- thing: unknown
Returns thing is ISerializedTranslation
- Defined in src/game/language/impl/TranslationImpl.ts:133

`Static` resolve

resolve(dictionary: default, entry: string | number, index?: number): string
Parameters
- dictionary: default
- entry: string | number
- Optional index: number
Returns string
- Defined in src/game/language/impl/TranslationImpl.ts:122

`Static` serializeTranslationArg

serializeTranslationArg(arg: any, depth?: number, maxSerializationDepth?: number): TranslationArg
Parameters
- arg: any
- depth: number = 0
- maxSerializationDepth: number = 50
Returns TranslationArg
- Defined in src/game/language/impl/TranslationImpl.ts:625

Class default

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

dictionary: string | default

entry: string | number

Optional index: number | "random"

Returns default

Parameters

translationId: string

Returns default

Properties

Readonly args

Readonly id

Readonly isValid

Readonly reformatters

Static sectionStringRenderers

Accessors

context

Returns TextContext

Static config

Returns undefined | ITranslationConfig

Parameters

config: undefined | ITranslationConfig

Returns void

Methods

addArgs

Parameters

Rest ...args: TranslationArg[]

Returns default

classed

Parameters

Rest ...classes: (string | Supplier<undefined | string, []>)[]

Returns default

clone

Returns default

equals

Parameters

translation: default

Returns boolean

get

Parameters

Rest ...args: any[]

Returns IStringSection[]

getDictionary

Returns default

getReference

Returns undefined | Reference

getReferenceContext

Returns undefined | InfoProviderContext

getString

Parameters

Rest ...args: any[]

Returns string

hasFailWith

Parameters

notEmptyString: boolean = false

Returns boolean

hasTranslation

Returns boolean

inContext

Parameters

context: TextContext = TextContext.None

normalize: boolean = false

Returns default

orElse

Parameters

Optional translation: GetterOfOr<undefined | default>

Returns undefined | default

passTo

Parameters

reformatters: ArrayOr<Reformatter>

Rest ...args: TranslationArg[]

`Optional` index: number | "random"

`Readonly` args

`Readonly` id

`Readonly` isValid

`Readonly` reformatters

`Static` sectionStringRenderers

`Static` config

`Rest` ...args: TranslationArg[]

`Rest` ...classes: (string | Supplier<undefined | string, []>)[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` translation: GetterOfOr<undefined | default>

`Rest` ...args: TranslationArg[]

`Rest` ...args: TranslationArg[]

`Optional` failWith: string | default | IStringSection[]

`Optional` reference: Reference | Referenceable

`Optional` context: InfoProviderContext

`Optional` forceInclude: true

`Rest` ...events: K[]

`Rest` ...segments: ISegment[]

`Rest` ...segments: ISegment[]

`Optional` tooltip: default | IStringSection[] | ((tooltip: default) => any) | Falsy

`Optional` wide: true

`Static` deserialize

`Static` generator

`Optional` link: Link

`Static` getAll