Class default

Hierarchy

default

Implements

Omit<ISerializable, "deserializeObject">

Index

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:194
new default(translationId: string): default
Parameters
- translationId: string
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:195

Properties

`Readonly` args

args: TranslationArg[] = []

`Readonly` id

id: string

`Readonly` isValid

isValid: boolean

`Readonly` reformatters

reformatters: (default | ((sections: IStringSection[]) => IStringSection[]))[] = []

`Static` sectionStringRenderers

sectionStringRenderers: ((section: IStringSection) => undefined | string)[] = []

Accessors

context

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

`Static` config

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

Methods

addArgs

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

clone

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

equals

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

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:361

getReference

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

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:387

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:325

hasTranslation

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

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:282

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:354

passTo

passTo(...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]): default
Parameters
- Rest ...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:289
passTo(beginning: true, ...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]): default
Parameters
- beginning: true
- Rest ...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:290

serialize

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

serializeObject

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

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:315

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:334

setReference

setReference(reference?: Reference | Referenceable): default
Parameters
- Optional reference: Reference | Referenceable
Returns default
- Defined in src/game/language/impl/TranslationImpl.ts:268

toString

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

withSegments

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

withTooltip

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

`Static` deserialize

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

`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:155

`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:62

`Static` getString

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

`Static` isSerializedTranslation

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

`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:92

`Static` serializeTranslationArg

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

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

clone

Returns default

equals

Parameters

translation: default

Returns boolean

get

Parameters

Rest ...args: any[]

Returns IStringSection[]

getReference

Returns undefined | Reference

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

Rest ...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]

Returns default

Parameters

beginning: true

Rest ...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]

Returns default

serialize

Parameters

depth: number = 0

Returns ISerializedTranslation

`Optional` index: number | "random"

`Readonly` args

`Readonly` id

`Readonly` isValid

`Readonly` reformatters

`Static` sectionStringRenderers

`Static` config

`Rest` ...args: TranslationArg[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` translation: GetterOfOr<undefined | default>

`Rest` ...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]

`Rest` ...reformatters: (Falsy | default | ((sections: IStringSection[]) => IStringSection[]))[]

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

`Optional` reference: Reference | Referenceable

`Rest` ...segments: ISegment[]

`Rest` ...segments: ISegment[]

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

`Static` deserialize

`Static` generator

`Optional` link: Link

`Static` getAll

`Optional` entry: string | number

`Static` getString

`Rest` ...entries: ArrayOfIterablesOr<string | default | IStringSection>

`Static` isSerializedTranslation

`Static` resolve

`Optional` index: number

`Static` serializeTranslationArg