Skip to main content

Class: ScriptsManager

Defined in: src/core/components/ScriptsManager.ts:7

Constructors

Constructor

new ScriptsManager(initScriptFunction): ScriptsManager

Defined in: src/core/components/ScriptsManager.ts:23

Parameters

initScriptFunction

(script) => Promise<void>

Returns

ScriptsManager

Properties

callKeyDownBound()

callKeyDownBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:17

Parameters

event

KeyEvent

Returns

void


callKeyUpBound()

callKeyUpBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:18

Parameters

event

KeyEvent

Returns

void


callSelectBound()

callSelectBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:13

Parameters

event

SelectEvent

Returns

void


callSelectEndBound()

callSelectEndBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:12

Parameters

event

SelectEvent

Returns

void


callSelectStartBound()

callSelectStartBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:11

Parameters

event

SelectEvent

Returns

void


callSqueezeBound()

callSqueezeBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:16

Parameters

event

SelectEvent

Returns

void


callSqueezeEndBound()

callSqueezeEndBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:15

Parameters

event

SelectEvent

Returns

void


callSqueezeStartBound()

callSqueezeStartBound: (event) => void

Defined in: src/core/components/ScriptsManager.ts:14

Parameters

event

SelectEvent

Returns

void


scripts

scripts: Set<Script<Object3DEventMap>>

Defined in: src/core/components/ScriptsManager.ts:9

The set of all currently initialized scripts.

Methods

callKeyDown()

callKeyDown(event): void

Defined in: src/core/components/ScriptsManager.ts:117

Parameters

event

KeyEvent

Returns

void


callKeyUp()

callKeyUp(event): void

Defined in: src/core/components/ScriptsManager.ts:123

Parameters

event

KeyEvent

Returns

void


callSelect()

callSelect(event): void

Defined in: src/core/components/ScriptsManager.ts:93

Parameters

event

SelectEvent

Returns

void


callSelectEnd()

callSelectEnd(event): void

Defined in: src/core/components/ScriptsManager.ts:87

Parameters

event

SelectEvent

Returns

void


callSelectStart()

callSelectStart(event): void

Defined in: src/core/components/ScriptsManager.ts:81

Parameters

event

SelectEvent

Returns

void


callSqueeze()

callSqueeze(event): void

Defined in: src/core/components/ScriptsManager.ts:111

Parameters

event

SelectEvent

Returns

void


callSqueezeEnd()

callSqueezeEnd(event): void

Defined in: src/core/components/ScriptsManager.ts:105

Parameters

event

SelectEvent

Returns

void


callSqueezeStart()

callSqueezeStart(event): void

Defined in: src/core/components/ScriptsManager.ts:99

Parameters

event

SelectEvent

Returns

void


initScript()

initScript(script): Promise<void>

Defined in: src/core/components/ScriptsManager.ts:32

Initializes a script and adds it to the set of scripts which will receive callbacks. This will be called automatically by Core when a script is found in the scene but can also be called manually.

Parameters

script

Script

The script to initialize

Returns

Promise<void>

A promise which resolves when the script is initialized.


onSimulatorStarted()

onSimulatorStarted(): void

Defined in: src/core/components/ScriptsManager.ts:141

Returns

void


onXRSessionEnded()

onXRSessionEnded(): void

Defined in: src/core/components/ScriptsManager.ts:135

Returns

void


onXRSessionStarted()

onXRSessionStarted(session): void

Defined in: src/core/components/ScriptsManager.ts:129

Parameters

session

XRSession

Returns

void


syncScriptsWithScene()

syncScriptsWithScene(scene): Promise<void>

Defined in: src/core/components/ScriptsManager.ts:62

Finds all scripts in the scene and initializes them or uninitailizes them. Returns a promise which resolves when all new scripts are finished initalizing.

Parameters

scene

Scene

The main scene which is used to find scripts.

Returns

Promise<void>


uninitScript()

uninitScript(script): void

Defined in: src/core/components/ScriptsManager.ts:47

Uninitializes a script calling dispose and removes it from the set of scripts which will receive callbacks.

Parameters

script

Script

The script to uninitialize.

Returns

void