Skip to main content

Class: ScriptsManager

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

Extends​

Constructors​

Constructor​

new ScriptsManager(initScriptFunction): ScriptsManager

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

Parameters​

initScriptFunction​

(script) => Promise<void>

Returns​

ScriptsManager

Overrides​

THREE.EventDispatcher<ScriptsManagerEventMap>.constructor

Properties​

catchExceptions​

catchExceptions: boolean = true

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

Whether to catch all exceptions thrown by developer scripts.

scripts​

scripts: Set<Script<Object3DEventMap>>

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

The set of all currently initialized scripts.

Methods​

callKeyDown()​

callKeyDown(event): void

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

Parameters​

event​

KeyEvent

Returns​

void

callKeyUp()​

callKeyUp(event): void

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

Parameters​

event​

KeyEvent

Returns​

void

callSelect()​

callSelect(event): void

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

Parameters​

event​

SelectEvent

Returns​

void

callSelectEnd()​

callSelectEnd(event): void

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

Parameters​

event​

SelectEvent

Returns​

void

callSelecting()​

callSelecting(controller): void

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

Parameters​

controller​

Controller

Returns​

void

callSelectStart()​

callSelectStart(event): void

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

Parameters​

event​

SelectEvent

Returns​

void

callSqueeze()​

callSqueeze(event): void

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

Parameters​

event​

SelectEvent

Returns​

void

callSqueezeEnd()​

callSqueezeEnd(event): void

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

Parameters​

event​

SelectEvent

Returns​

void

callSqueezeStart()​

callSqueezeStart(event): void

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

Parameters​

event​

SelectEvent

Returns​

void

callSqueezing()​

callSqueezing(controller): void

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

Parameters​

controller​

Controller

Returns​

void

initScript()​

initScript(script): Promise<void>

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

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:406

Returns​

void

onXRSessionEnded()​

onXRSessionEnded(): void

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

Returns​

void

onXRSessionStarted()​

onXRSessionStarted(session): void

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

Parameters​

session​

XRSession

Returns​

void

physicsStep()​

physicsStep(): void

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

Returns​

void

resetUX()​

resetUX(): void

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

Returns​

void

syncScriptsWithScene()​

syncScriptsWithScene(scene): Promise<PromiseSettledResult<void>[]>

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

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<PromiseSettledResult<void>[]>

uninitScript()​

uninitScript(script): void

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

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

update()​

update(time, frame): void

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

Parameters​

time​

number

frame​

XRFrame

Returns​

void