ICoreFunctions
Defined in: core/interfaces/ICoreFunctions.ts:15
Methods
Section titled “Methods”actions()
Section titled “actions()”actions<
T>(action):ActionSignal<T>
Defined in: core/interfaces/ICoreFunctions.ts:44
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”action
Section titled “action”string
Returns
Section titled “Returns”ActionSignal<T>
addFocusable()
Section titled “addFocusable()”addFocusable(
focusable,layerId?,isDefault?):void
Defined in: core/interfaces/ICoreFunctions.ts:17
Parameters
Section titled “Parameters”focusable
Section titled “focusable”IFocusable | IFocusable[]
layerId?
Section titled “layerId?”null | string | number
isDefault?
Section titled “isDefault?”boolean
Returns
Section titled “Returns”void
addFocusLayer()
Section titled “addFocusLayer()”addFocusLayer(
layerId?,setAsCurrent?,focusables?):IFocusLayer
Defined in: core/interfaces/ICoreFunctions.ts:24
Parameters
Section titled “Parameters”layerId?
Section titled “layerId?”string | number
setAsCurrent?
Section titled “setAsCurrent?”boolean
focusables?
Section titled “focusables?”IFocusable | IFocusable[]
Returns
Section titled “Returns”addPopup()
Section titled “addPopup()”addPopup<
T>(id,popup):void
Defined in: core/interfaces/ICoreFunctions.ts:52
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”void
clearFocus()
Section titled “clearFocus()”clearFocus():
void
Defined in: core/interfaces/ICoreFunctions.ts:28
Returns
Section titled “Returns”void
getAction()
Section titled “getAction()”getAction<
T>(action):ActionSignal<T>
Defined in: core/interfaces/ICoreFunctions.ts:40
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”action
Section titled “action”string
Returns
Section titled “Returns”ActionSignal<T>
getActions()
Section titled “getActions()”getActions():
ActionMap
Defined in: core/interfaces/ICoreFunctions.ts:41
Returns
Section titled “Returns”getAllPaths()
Section titled “getAllPaths()”getAllPaths():
string[]
Defined in: core/interfaces/ICoreFunctions.ts:72
Returns
Section titled “Returns”string[]
getChildAtPath()
Section titled “getChildAtPath()”getChildAtPath(
path):undefined|Container<ContainerChild>
Defined in: core/interfaces/ICoreFunctions.ts:68
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”undefined | Container<ContainerChild>
getChildrenAtPaths()
Section titled “getChildrenAtPaths()”getChildrenAtPaths(
paths):Container<ContainerChild>[]
Defined in: core/interfaces/ICoreFunctions.ts:69
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Container<ContainerChild>[]
getPathForChild()
Section titled “getPathForChild()”getPathForChild(
container):string
Defined in: core/interfaces/ICoreFunctions.ts:70
Parameters
Section titled “Parameters”container
Section titled “container”Container
Returns
Section titled “Returns”string
getPathsForChildren()
Section titled “getPathsForChildren()”getPathsForChildren(
containers):string[]
Defined in: core/interfaces/ICoreFunctions.ts:71
Parameters
Section titled “Parameters”containers
Section titled “containers”Container<ContainerChild>[]
Returns
Section titled “Returns”string[]
hidePopup()
Section titled “hidePopup()”hidePopup<
T>(id,data?):Promise<undefined|IPopup<T>>
Defined in: core/interfaces/ICoreFunctions.ts:54
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”string | number
T
Returns
Section titled “Returns”Promise<undefined | IPopup<T>>
isControllerActive()
Section titled “isControllerActive()”isControllerActive(
controller):boolean
Defined in: core/interfaces/ICoreFunctions.ts:36
Parameters
Section titled “Parameters”controller
Section titled “controller”Returns
Section titled “Returns”boolean
isGamepadActive()
Section titled “isGamepadActive()”isGamepadActive(
gamepad):boolean
Defined in: core/interfaces/ICoreFunctions.ts:37
Parameters
Section titled “Parameters”gamepad
Section titled “gamepad”Gamepad
Returns
Section titled “Returns”boolean
isKeyDown()
Section titled “isKeyDown()”isKeyDown(
key):boolean
Defined in: core/interfaces/ICoreFunctions.ts:49
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
loadAssets()
Section titled “loadAssets()”loadAssets(
assets):Promise<void>
Defined in: core/interfaces/ICoreFunctions.ts:61
Parameters
Section titled “Parameters”assets
Section titled “assets”string | string[]
Returns
Section titled “Returns”Promise<void>
loadBundles()
Section titled “loadBundles()”loadBundles(
bundle):Promise<void>
Defined in: core/interfaces/ICoreFunctions.ts:62
Parameters
Section titled “Parameters”bundle
Section titled “bundle”string | string[]
Returns
Section titled “Returns”Promise<void>
loadRequired()
Section titled “loadRequired()”loadRequired():
Promise<void>
Defined in: core/interfaces/ICoreFunctions.ts:65
Returns
Section titled “Returns”Promise<void>
loadScene()
Section titled “loadScene()”loadScene(
sceneIdOrLoadSceneConfig):Promise<void>
Defined in: core/interfaces/ICoreFunctions.ts:58
Parameters
Section titled “Parameters”sceneIdOrLoadSceneConfig
Section titled “sceneIdOrLoadSceneConfig”string | LoadSceneConfig
Returns
Section titled “Returns”Promise<void>
loadSceneAssets()
Section titled “loadSceneAssets()”loadSceneAssets(
scene,background?):Promise<void>
Defined in: core/interfaces/ICoreFunctions.ts:63
Parameters
Section titled “Parameters”background?
Section titled “background?”boolean
Returns
Section titled “Returns”Promise<void>
onKeyDown()
Section titled “onKeyDown()”onKeyDown(
key?):KeySignal
Defined in: core/interfaces/ICoreFunctions.ts:47
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”onKeyUp()
Section titled “onKeyUp()”onKeyUp(
key?):KeySignal
Defined in: core/interfaces/ICoreFunctions.ts:48
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”removeAllFocusLayers()
Section titled “removeAllFocusLayers()”removeAllFocusLayers():
void
Defined in: core/interfaces/ICoreFunctions.ts:29
Returns
Section titled “Returns”void
removeAllPopups()
Section titled “removeAllPopups()”removeAllPopups(
animate?):void
Defined in: core/interfaces/ICoreFunctions.ts:55
Parameters
Section titled “Parameters”animate?
Section titled “animate?”boolean
Returns
Section titled “Returns”void
removeFocusable()
Section titled “removeFocusable()”removeFocusable(
focusable):void
Defined in: core/interfaces/ICoreFunctions.ts:22
Parameters
Section titled “Parameters”focusable
Section titled “focusable”IFocusable | IFocusable[]
Returns
Section titled “Returns”void
removeFocusLayer()
Section titled “removeFocusLayer()”removeFocusLayer(
layerId?,removeTopLayerIfUndefined?):void
Defined in: core/interfaces/ICoreFunctions.ts:25
Parameters
Section titled “Parameters”layerId?
Section titled “layerId?”string | number
removeTopLayerIfUndefined?
Section titled “removeTopLayerIfUndefined?”boolean
Returns
Section titled “Returns”void
sendAction()
Section titled “sendAction()”sendAction<
T>(actionId,data?):void
Defined in: core/interfaces/ICoreFunctions.ts:42
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”actionId
Section titled “actionId”string | number
T
Returns
Section titled “Returns”void
setActionContext()
Section titled “setActionContext()”setActionContext(
context):string
Defined in: core/interfaces/ICoreFunctions.ts:43
Parameters
Section titled “Parameters”context
Section titled “context”string | string & object
Returns
Section titled “Returns”string
setFocus()
Section titled “setFocus()”setFocus(
focusable):IFocusable
Defined in: core/interfaces/ICoreFunctions.ts:26
Parameters
Section titled “Parameters”focusable
Section titled “focusable”Returns
Section titled “Returns”setFocusLayer()
Section titled “setFocusLayer()”setFocusLayer(
layerId):void
Defined in: core/interfaces/ICoreFunctions.ts:27
Parameters
Section titled “Parameters”layerId
Section titled “layerId”string | number
Returns
Section titled “Returns”void
setLayerOrder()
Section titled “setLayerOrder()”setLayerOrder(
layerIds):void
Defined in: core/interfaces/ICoreFunctions.ts:23
Parameters
Section titled “Parameters”layerIds
Section titled “layerIds”(string | number)[]
Returns
Section titled “Returns”void
setLocale()
Section titled “setLocale()”setLocale(
localeId):void
Defined in: core/interfaces/ICoreFunctions.ts:32
Parameters
Section titled “Parameters”localeId
Section titled “localeId”string
Returns
Section titled “Returns”void
showPopup()
Section titled “showPopup()”showPopup<
T>(id,config?):Promise<undefined|IPopup<T>>
Defined in: core/interfaces/ICoreFunctions.ts:53
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”string | number
config?
Section titled “config?”Partial<PopupConfig<T>>
Returns
Section titled “Returns”Promise<undefined | IPopup<T>>
t(
key,params?,locale?):string
Defined in: core/interfaces/ICoreFunctions.ts:33
Parameters
Section titled “Parameters”string
params?
Section titled “params?”locale?
Section titled “locale?”string
Returns
Section titled “Returns”string
translate()
Section titled “translate()”translate(
key,params?,locale?):string
Defined in: core/interfaces/ICoreFunctions.ts:34
Parameters
Section titled “Parameters”string
params?
Section titled “params?”locale?
Section titled “locale?”string
Returns
Section titled “Returns”string
unloadSceneAssets()
Section titled “unloadSceneAssets()”unloadSceneAssets(
scene):Promise<void>
Defined in: core/interfaces/ICoreFunctions.ts:64
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>