Skip to content

Interface: System<S, Q>

Defined in: packages/core/src/ecs/system.ts:45

System base interface wired to the IWSDK World, renderer, and XR runtime.

Remarks

  • createSystem(queries, schema) returns a class that implements this interface.
  • Config values are exposed as reactive Signals on this.config.<key>.
  • Common world resources are available as readonly properties (player, input, scene, camera, renderer, visibilityState).
  • Use cleanupFuncs.push(() => ...) to register teardown callbacks.

Extends

  • System<S, Q>

Extended by

Type Parameters

S

S extends SystemSchema

Q

Q extends SystemQueries

Properties

camera

readonly camera: PerspectiveCamera

Defined in: packages/core/src/ecs/system.ts:60


cleanupFuncs

readonly cleanupFuncs: () => void[]

Defined in: packages/core/src/ecs/system.ts:63

Returns

void


config

config: SystemConfigSignals<S>

Defined in: packages/core/src/ecs/system.ts:48

Overrides

ElicsSystem.config


createEntity()

createEntity: () => Entity

Defined in: packages/core/src/ecs/system.ts:69

Returns

Entity

Overrides

ElicsSystem.createEntity


globals

globals: Record<string, any>

Defined in: packages/core/src/ecs/system.ts:53

Overrides

ElicsSystem.globals


input

readonly input: XRInputManager

Defined in: packages/core/src/ecs/system.ts:58


isPaused

isPaused: boolean

Defined in: packages/core/src/ecs/system.ts:47

Overrides

ElicsSystem.isPaused


player

readonly player: XROrigin

Defined in: packages/core/src/ecs/system.ts:57


priority

priority: number

Defined in: packages/core/src/ecs/system.ts:52

Overrides

ElicsSystem.priority


queries

queries: Record<keyof Q, Query>

Defined in: packages/core/src/ecs/system.ts:49

Overrides

ElicsSystem.queries


queryManager

queryManager: QueryManager

Defined in: packages/core/src/ecs/system.ts:51

Overrides

ElicsSystem.queryManager


renderer

readonly renderer: WebGLRenderer

Defined in: packages/core/src/ecs/system.ts:61


scene

readonly scene: Scene

Defined in: packages/core/src/ecs/system.ts:59


visibilityState

readonly visibilityState: Signal<VisibilityState>

Defined in: packages/core/src/ecs/system.ts:62


world

world: World

Defined in: packages/core/src/ecs/system.ts:50

Overrides

ElicsSystem.world


xrFrame

xrFrame: XRFrame

Defined in: packages/core/src/ecs/system.ts:55


xrManager

xrManager: WebXRManager

Defined in: packages/core/src/ecs/system.ts:54

Methods

init()

init(): void

Defined in: packages/core/src/ecs/system.ts:65

Returns

void

Overrides

ElicsSystem.init


play()

play(): void

Defined in: packages/core/src/ecs/system.ts:67

Returns

void

Overrides

ElicsSystem.play


stop()

stop(): void

Defined in: packages/core/src/ecs/system.ts:68

Returns

void

Overrides

ElicsSystem.stop


update()

update(delta, time): void

Defined in: packages/core/src/ecs/system.ts:66

Parameters

delta

number

time

number

Returns

void

Overrides

ElicsSystem.update