SceneStreamingController
Defined in: scene/sceneStreaming.ts:89
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SceneStreamingController(
host,config?):SceneStreamingController
Defined in: scene/sceneStreaming.ts:104
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”SceneStreamingController
Methods
Section titled “Methods”clear()
Section titled “clear()”clear():
void
Defined in: scene/sceneStreaming.ts:124
Returns
Section titled “Returns”void
configure()
Section titled “configure()”configure(
config):void
Defined in: scene/sceneStreaming.ts:109
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”void
getActive()
Section titled “getActive()”getActive():
string[]
Defined in: scene/sceneStreaming.ts:149
Scenes the controller currently holds in-range.
Returns
Section titled “Returns”string[]
getFocusEntity()
Section titled “getFocusEntity()”getFocusEntity():
number|null
Defined in: scene/sceneStreaming.ts:144
Returns
Section titled “Returns”number | null
register()
Section titled “register()”register(
cell):void
Defined in: scene/sceneStreaming.ts:115
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setFocus()
Section titled “setFocus()”setFocus(
x,y,z?):void
Defined in: scene/sceneStreaming.ts:133
Set the focus directly (or let the streaming system read a focus entity).
Parameters
Section titled “Parameters”number
number
number = 0
Returns
Section titled “Returns”void
z defaults to the plane a flat game’s cells sit on.
setFocusEntity()
Section titled “setFocusEntity()”setFocusEntity(
entity):void
Defined in: scene/sceneStreaming.ts:140
Follow an entity; the streaming system reads its Transform each tick.
Parameters
Section titled “Parameters”entity
Section titled “entity”number | null
Returns
Section titled “Returns”void
unregister()
Section titled “unregister()”unregister(
scene):void
Defined in: scene/sceneStreaming.ts:119
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
update()
Section titled “update()”update():
void
Defined in: scene/sceneStreaming.ts:154
Reconcile resident cells against the current focus. Idempotent per tick.
Returns
Section titled “Returns”void