Class GameVariables

Hierarchy (view full)

EventEmitter<GameVariablesEvents>
- GameVariables

Index

Constructors

Properties

#setVariables _events gp list platformAdapter state

Accessors

isPlatformVariablesAvailable

Methods

fetch fetchPlatformVariables get has off on once type

Constructors

constructor

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

Properties

`Private` #setVariables

#setVariables: ((variables) => void) = ...

Type declaration

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

`Private` _events

_events: EventLite = ...

`Private` gp

list

list: ProjectVariable[] = []

`Private` platformAdapter

platformAdapter: default

`Private` state

state: VariablesState = {}

Accessors

isPlatformVariablesAvailable

get isPlatformVariablesAvailable(): boolean
Returns boolean
- Defined in core/variables/GameVariables.ts:37

Methods

fetch

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

fetchPlatformVariables

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

get

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

has

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

off

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

on

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

once

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

type

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