Class: ScriptsManager

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

Extends

• EventDispatcher<ScriptsManagerEventMap>

Implements

• InteractionCallbackDispatch

Constructors

Constructor

new ScriptsManager(initScriptFunction): ScriptsManager

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

Parameters

initScriptFunction

(script) => Promise<void>

Returns

ScriptsManager

Overrides

THREE.EventDispatcher<ScriptsManagerEventMap>.constructor

Properties

afterDispose()?

optional afterDispose: (script) => void

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

Parameters

script

Script

Returns

void

---

beforeDispose()?

optional beforeDispose: (script) => void

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

Parameters

script

Script

Returns

void

---

catchExceptions

catchExceptions: boolean = true

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

Whether to catch all exceptions thrown by developer scripts.

Accessors

directTouchCandidates

Get Signature

get directTouchCandidates(): ReadonlySet<Object3D<Object3DEventMap>>

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

Objects found during the lifecycle traversal that direct touch can use.

Returns

ReadonlySet<Object3D<Object3DEventMap>>

Methods

callKeyDown()

callKeyDown(event): void

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

Parameters

event

KeyEvent

Returns

void

---

callKeyUp()

callKeyUp(event): void

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

Parameters

event

KeyEvent

Returns

void

---

callLongSelect()

callLongSelect(event): void

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

Parameters

event

LongSelectEvent

Returns

void

---

callSelect()

callSelect(event): void

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

Parameters

event

SelectEvent

Returns

void

---

callSelectEnd()

callSelectEnd(event): void

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

Parameters

event

SelectEndEvent

Returns

void

---

callSelecting()

callSelecting(event): void

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

Parameters

event

SelectEvent

Returns

void

---

callSelectStart()

callSelectStart(event): void

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

Parameters

event

SelectEvent

Returns

void

---

callSqueeze()

callSqueeze(raw): void

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

Parameters

raw

ControllerEvent

Returns

void

---

callSqueezeEnd()

callSqueezeEnd(raw): void

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

Parameters

raw

ControllerEvent

Returns

void

---

callSqueezeStart()

callSqueezeStart(raw): void

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

Parameters

raw

ControllerEvent

Returns

void

---

callSqueezing()

callSqueezing(controller): void

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

Parameters

controller

Controller

Returns

void

---

callTargeted()

callTargeted(path, context, callback): void

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

Calls one targeted hook along a captured Script path. Developer errors use the same exception policy as global Script callbacks.

Parameters

path

Iterable<Script<Object3DEventMap>>

context

string

callback

(script) => void

Returns

void

---

dispose()

dispose(): Promise<void>

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

Disposes every Script generation and prevents further initialization.

Returns

Promise<void>

---

hasTargetHandler()

hasTargetHandler(object, sourceType): boolean

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

Parameters

object

Object3D

sourceType

InteractionSourceType

Returns

boolean

Implementation of

InteractionCallbackDispatch.hasTargetHandler

---

hasTargetHook()

hasTargetHook(object, hook): boolean

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

Parameters

object

Object3D

hook

TargetedInteractionHook

Returns

boolean

Implementation of

InteractionCallbackDispatch.hasTargetHook

---

initScript()

initScript(script): Promise<void>

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

Initializes a script and adds it to the set of scripts which will receive callbacks. Concurrent calls share one initialization.

Parameters

script

Script

The script to initialize

Returns

Promise<void>

A promise which resolves when the script is initialized.

---

invokeGlobal()

invokeGlobal<Hook>(hook, event): void

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

Type Parameters

Hook

Hook extends GlobalInteractionHook

Parameters

hook

Hook

event

GlobalInteractionEvent<Hook>

Returns

void

Implementation of

InteractionCallbackDispatch.invokeGlobal

---

invokeManipulation()

invokeManipulation(script, event): void

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

Parameters

script

Script

event

ManipulationEvent

Returns

void

Implementation of

InteractionCallbackDispatch.invokeManipulation

---

invokeSemantic()

invokeSemantic(object, callback): void

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

Parameters

object

Object3D

callback

() => void

Returns

void

Implementation of

InteractionCallbackDispatch.invokeSemantic

---

invokeTarget()

invokeTarget(object, hook, argument): void

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

Parameters

object

Object3D

hook

TargetedInteractionHook

argument

unknown

Returns

void

Implementation of

InteractionCallbackDispatch.invokeTarget

---

isScript()

isScript(object): boolean

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

Parameters

object

Object3D

Returns

boolean

Implementation of

InteractionCallbackDispatch.isScript

---

onSimulatorStarted()

onSimulatorStarted(): void

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

Returns

void

---

onXRSessionEnded()

onXRSessionEnded(): void

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

Returns

void

---

onXRSessionStarted()

onXRSessionStarted(session): void

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

Parameters

session

XRSession

Returns

void

---

physicsStep()

physicsStep(): void

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

Returns

void

---

reportError()

reportError(error, script, context): void

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

Reports an asynchronous subsystem error against its owning Script.

Parameters

error

unknown

script

Script

context

string

Returns

void

---

syncScriptsWithScene()

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

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

Finds all scripts in the scene and initializes them or uninitializes them. Returns a promise which resolves when all new scripts finish initializing.

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

Uninitializes a script calling dispose and removes it from the set of scripts which will receive callbacks. A pending initialization is disposed after it finishes and is never activated.

Parameters

script

Script

The script to uninitialize.

Returns

void

---

update()

update(time, frame): void

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

Parameters

time

number

frame

XRFrame

Returns

void