Class GameVariables

Hierarchy

EventEmitter<GameVariablesEvents>
- GameVariables

Index

Constructors

constructor

Properties

Accessors

isPlatformVariablesAvailable

Methods

Constructors

constructor

new GameVariables(gp: CoreSDK, platformAdapter: default, variables: ProjectVariable[]): GameVariables

Overrides EventEmitter.constructor
- Defined in core/variables/GameVariables.ts:32
Parameters
- gp: CoreSDK
- platformAdapter: default
- variables: ProjectVariable[]
Returns GameVariables

Properties

Private #setVariables

#setVariables: ((variables: ProjectVariable[]) => void) = ...

Type declaration

- (variables: ProjectVariable[]): void
- Parameters
  - variables: ProjectVariable[]
  Returns void

Private _events

_events: EventLite = ...

list

list: ProjectVariable[] = []

Private state

state: VariablesState = {}

Accessors

isPlatformVariablesAvailable

get isPlatformVariablesAvailable(): boolean

- Defined in core/variables/GameVariables.ts:37
Returns boolean

Methods

fetch

fetch(): Promise<ProjectVariable[]>

- Defined in core/variables/GameVariables.ts:66
Returns Promise<ProjectVariable[]>

fetchPlatformVariables

fetchPlatformVariables(input: GetVariablesInput): Promise<Record<string, any>>

- Defined in core/variables/GameVariables.ts:79
Parameters
- input: GetVariablesInput
Returns Promise<Record<string, any>>

get

get(key: string): string | number | boolean

- Defined in core/variables/GameVariables.ts:53
Parameters
- key: string
Returns string | number | boolean

has

has(key: string): boolean

- Defined in core/variables/GameVariables.ts:57
Parameters
- key: string
Returns boolean

off

off<ET>(type: ET, handler: ((event: GameVariablesEvents[ET]) => void)): void

Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12
Type Parameters
- ET extends keyof GameVariablesEvents
Parameters
- type: ET
- handler: ((event: GameVariablesEvents[ET]) => void)
  - - (event: GameVariablesEvents[ET]): void
    - Parameters
      - event: GameVariablesEvents[ET]
      Returns void
Returns void

on

on<ET>(type: ET, handler: ((event: GameVariablesEvents[ET]) => void)): void

Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9
Type Parameters
- ET extends keyof GameVariablesEvents
Parameters
- type: ET
- handler: ((event: GameVariablesEvents[ET]) => void)
  - - (event: GameVariablesEvents[ET]): void
    - Parameters
      - event: GameVariablesEvents[ET]
      Returns void
Returns void

once

once<ET>(type: ET, handler: ((event: GameVariablesEvents[ET]) => void)): void

Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15
Type Parameters
- ET extends keyof GameVariablesEvents
Parameters
- type: ET
- handler: ((event: GameVariablesEvents[ET]) => void)
  - - (event: GameVariablesEvents[ET]): void
    - Parameters
      - event: GameVariablesEvents[ET]
      Returns void
Returns void

type

type(key: string): "stats" | "data" | "flag" | "file" | "image" | "doc_html"

- Defined in core/variables/GameVariables.ts:61
Parameters
- key: string
Returns "stats" | "data" | "flag" | "file" | "image" | "doc_html"

Generated using TypeDoc