ICoreFunctions

Defined in: core/interfaces/ICoreFunctions.ts:14

Methods

actions()

actions<T>(action): ActionSignal<T>

Defined in: core/interfaces/ICoreFunctions.ts:43

Type Parameters

• T = any

Parameters

action

string

Returns

ActionSignal<T>

---

addFocusable()

addFocusable(focusable, layerId?, isDefault?): void

Defined in: core/interfaces/ICoreFunctions.ts:16

Parameters

focusable

IFocusable | IFocusable[]

layerId?

null | string | number

isDefault?

boolean

Returns

void

---

addFocusLayer()

addFocusLayer(layerId?, setAsCurrent?, focusables?): IFocusLayer

Defined in: core/interfaces/ICoreFunctions.ts:23

Parameters

layerId?

string | number

setAsCurrent?

boolean

focusables?

IFocusable | IFocusable[]

Returns

IFocusLayer

---

addPopup()

addPopup<T>(id, popup): void

Defined in: core/interfaces/ICoreFunctions.ts:51

Type Parameters

• T = any

Parameters

id

string | number

popup

PopupConstructor<T>

Returns

void

---

clearFocus()

clearFocus(): void

Defined in: core/interfaces/ICoreFunctions.ts:27

Returns

void

---

getAction()

getAction<T>(action): ActionSignal<T>

Defined in: core/interfaces/ICoreFunctions.ts:39

Type Parameters

• T = any

Parameters

action

string

Returns

ActionSignal<T>

---

getActions()

getActions(): ActionMap

Defined in: core/interfaces/ICoreFunctions.ts:40

Returns

ActionMap

---

hidePopup()

hidePopup<T>(id, data?): Promise<undefined | IPopup<T>>

Defined in: core/interfaces/ICoreFunctions.ts:53

Type Parameters

• T = any

Parameters

id

string | number

data?

T

Returns

Promise<undefined | IPopup<T>>

---

isControllerActive()

isControllerActive(controller): boolean

Defined in: core/interfaces/ICoreFunctions.ts:35

Parameters

controller

InputController

Returns

boolean

---

isGamepadActive()

isGamepadActive(gamepad): boolean

Defined in: core/interfaces/ICoreFunctions.ts:36

Parameters

gamepad

Gamepad

Returns

boolean

---

isKeyDown()

isKeyDown(key): boolean

Defined in: core/interfaces/ICoreFunctions.ts:48

Parameters

key

string

Returns

boolean

---

loadAssets()

loadAssets(assets): Promise<void>

Defined in: core/interfaces/ICoreFunctions.ts:60

Parameters

assets

string | string[]

Returns

Promise<void>

---

loadBundles()

loadBundles(bundle): Promise<void>

Defined in: core/interfaces/ICoreFunctions.ts:61

Parameters

bundle

string | string[]

Returns

Promise<void>

---

loadRequired()

loadRequired(): Promise<void>

Defined in: core/interfaces/ICoreFunctions.ts:64

Returns

Promise<void>

---

loadScene()

loadScene(sceneIdOrLoadSceneConfig): Promise<void>

Defined in: core/interfaces/ICoreFunctions.ts:57

Parameters

sceneIdOrLoadSceneConfig

string | LoadSceneConfig

Returns

Promise<void>

---

loadSceneAssets()

loadSceneAssets(scene, background?): Promise<void>

Defined in: core/interfaces/ICoreFunctions.ts:62

Parameters

scene

IScene

background?

boolean

Returns

Promise<void>

---

onKeyDown()

onKeyDown(key?): KeySignal

Defined in: core/interfaces/ICoreFunctions.ts:46

Parameters

key?

string

Returns

KeySignal

---

onKeyUp()

onKeyUp(key?): KeySignal

Defined in: core/interfaces/ICoreFunctions.ts:47

Parameters

key?

string

Returns

KeySignal

---

removeAllFocusLayers()

removeAllFocusLayers(): void

Defined in: core/interfaces/ICoreFunctions.ts:28

Returns

void

---

removeAllPopups()

removeAllPopups(animate?): void

Defined in: core/interfaces/ICoreFunctions.ts:54

Parameters

animate?

boolean

Returns

void

---

removeFocusable()

removeFocusable(focusable): void

Defined in: core/interfaces/ICoreFunctions.ts:21

Parameters

focusable

IFocusable | IFocusable[]

Returns

void

---

removeFocusLayer()

removeFocusLayer(layerId?, removeTopLayerIfUndefined?): void

Defined in: core/interfaces/ICoreFunctions.ts:24

Parameters

layerId?

string | number

removeTopLayerIfUndefined?

boolean

Returns

void

---

sendAction()

sendAction<T>(actionId, data?): void

Defined in: core/interfaces/ICoreFunctions.ts:41

Type Parameters

• T = any

Parameters

actionId

string | number

data?

T

Returns

void

---

setActionContext()

setActionContext(context): string

Defined in: core/interfaces/ICoreFunctions.ts:42

Parameters

context

string | string & object

Returns

string

---

setFocus()

setFocus(focusable): IFocusable

Defined in: core/interfaces/ICoreFunctions.ts:25

Parameters

focusable

IFocusable

Returns

IFocusable

---

setFocusLayer()

setFocusLayer(layerId): void

Defined in: core/interfaces/ICoreFunctions.ts:26

Parameters

layerId

string | number

Returns

void

---

setLayerOrder()

setLayerOrder(layerIds): void

Defined in: core/interfaces/ICoreFunctions.ts:22

Parameters

layerIds

(string | number)[]

Returns

void

---

setLocale()

setLocale(localeId): void

Defined in: core/interfaces/ICoreFunctions.ts:31

Parameters

localeId

string

Returns

void

---

showPopup()

showPopup<T>(id, config?): Promise<undefined | IPopup<T>>

Defined in: core/interfaces/ICoreFunctions.ts:52

Type Parameters

• T = any

Parameters

id

string | number

config?

Partial<PopupConfig<T>>

Returns

Promise<undefined | IPopup<T>>

---

t()

t(key, params?, locale?): string

Defined in: core/interfaces/ICoreFunctions.ts:32

Parameters

key

string

params?

i18nTParams

locale?

string

Returns

string

---

translate()

translate(key, params?, locale?): string

Defined in: core/interfaces/ICoreFunctions.ts:33

Parameters

key

string

params?

i18nTParams

locale?

string

Returns

string

---

unloadSceneAssets()

unloadSceneAssets(scene): Promise<void>

Defined in: core/interfaces/ICoreFunctions.ts:63

Parameters

scene

IScene

Returns

Promise<void>