Class: Context

new Context(gameScriptClass, object3D)

Handle collisions, add/remove gameobject3D, process commands + trigger ScriptBase event

Parameters:

Name	Type	Description
`gameScriptClass`	Object.<string, ScriptBase>	map of class extended `ScriptBase`
`object3D`	Object3D	root game object3D

Source: Context.js, line 24

Members

collisions :Collisions

Collisions system https://www.npmjs.com/package/detect-collisions

Type:

Collisions

Source: Context.js, line 83

collisionsBuffer :Object.<string, string>

Buffer to handle collision events Context.EVENT

Type:

Object.<string, string>

Source: Context.js, line 90

commands :Map.<string, Array>

commands buffer

Type:

Map.<string, Array>

Source: Context.js, line 111

dt :number

delta time

Type:

number

Source: Context.js, line 105

gameScriptClass :Object.<string, ScriptBase>

class that can be reference by GameScript of an object3D

Type:

Object.<string, ScriptBase>

Source: Context.js, line 68

listeners :Object.<string, Array.<ContextListener>>

Listeners of custom events

Type:

Object.<string, Array.<ContextListener>>

Source: Context.js, line 98

object3D :Object3D

root game object3D

Type:

Object3D

Source: Context.js, line 75

(static) EVENT :Object.<string, string>

Events triggered by context to ScriptBase

Type:

Object.<string, string>

Source: Context.js, line 636

Methods

addObject3D(obj, parentUUIDopt) → {Promise}

Add an object3D in context. If a parentUUID is specifed it will be add to its, root otherwise

Parameters:

Name	Type	Attributes	Default	Description
`obj`	Object3D			object3D to add
`parentUUID`	string	<optional>	null	uuid of parent object3D

Source: Context.js, line 520

Returns:

promise resolving when add

Type:: Promise

createInstanceOf(id, object3D, modelVariables) → {ScriptBase}

Create a class instance of game script class for an object3D given an id

Parameters:

Name	Type	Description
`id`	string	id of the class
`object3D`	Object3D	object3D that is going to use this instance
`modelVariables`	object	custom variables associated to this instance

Source: Context.js, line 122

Returns:

instance of the class bind with object3D and modelVariables

Type:: ScriptBase

dispatch(eventID, args)

Dispatch custom event to listeners

Parameters:

Name	Type	Description
`eventID`	string	Id of the event to dispatch
`args`	Array	Params to passed to listeners

Source: Context.js, line 563

dispatchScriptEvent(object3D, event, params, recursiveopt)

It will dispatch an event to all ScriptBase in object3D

Parameters:

Name	Type	Attributes	Default	Description
`object3D`	Object3D			object3D that you want to dispatch the event to.
`event`	string			name of the event to dispatch see possible value in `Context.EVENT`
`params`	Array.<any>			params to pass to `ScriptBase`
`recursive`	boolean	<optional>	true	traverse object3D child if true

Source: Context.js, line 310

findGameScriptWithID(id, object3Dopt) → {ScriptBase|null}

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			id of script
`object3D`	Object3D	<optional>	this.object3D	object3D to traverse to find the game script (default is the root game object3D)

Source: Context.js, line 609

Returns:

first game script with id or null if none are found

Type:: ScriptBase | null

initComponentControllers(obj)

Initialize controllers used in context

Parameters:

Name	Type	Description
`obj`	Object3D	object3D to initialize controllers

Source: Context.js, line 331

load() → {Promise}

Load its object3D

Source: Context.js, line 139

Returns:

promise resolving at the end of the load

Type:: Promise

loadObject3D(obj) → {Promise}

Load an object3D into context

Parameters:

Name	Type	Description
`obj`	Object3D	object3D to load

Source: Context.js, line 149

Returns:

promise resolving at the end of the load

Type:: Promise

on(eventID, cb)

Parameters:

Name	Type	Description
`eventID`	string	Id of the event
`cb`	function	Callback to be called when the event is dispatched

Source: Context.js, line 552

onCommands(cmds)

Pass new commands to apply at the next step

Parameters:

Name	Type	Description
`cmds`	Array.<Command>	new commands to apply at the next step

Source: Context.js, line 576

registerObject3DCollision(object3D)

Add a object3D into the collision system

Parameters:

Name	Type	Description
`object3D`	Object3D	object3D to register

Source: Context.js, line 394

removeObject3D(uuid)

Remove a object3D of context

Parameters:

Name	Type	Description
`uuid`	string	uuid of the object3D to remove

Source: Context.js, line 536

step(dt)

Step context

Parameters:

Name	Type	Description
`dt`	number	new delta time of step

Source: Context.js, line 188

toState(full) → {State}

Convert context root object3D to State and reset outdated attributes of all object3D

Parameters:

Name	Type	Default	Description
`full`	boolean	true	model of object3D with controllers should be export

Source: Context.js, line 589

Returns:

current state of context

Type:: State

unregisterObject3DCollision(object3D)

Remove a GameObject from the collision system

Parameters:

Name	Type	Description
`object3D`	Object3D	object3D to remove

Source: Context.js, line 492

updateCollision(object3D)

Update object3D collider controller + update collisions system

Parameters:

Name	Type	Description
`object3D`	Object3D	object3D to update

Source: Context.js, line 418

updateCollisionBuffer()

Update the collision buffer

Source: Context.js, line 430