Class XRGameSystem

A game system that only updates when the app is in immersive mode.

Hierarchy

GameSystem
- XRGameSystem

Index

Constructors

constructor

new XRGameSystem(world: World<Entity>, attributes?: Attributes): XRGameSystem
Creates a new instance of the GameSystem class.
Parameters
- world: World<Entity>
  
  The World instance that this system will be added to.
- Optional attributes: Attributes
  
  Optional attributes to configure this system.
Returns XRGameSystem
Inherited from GameSystem.constructor
- Defined in src/ecs/GameSystem.ts:70

Properties

`Optional` config

config?: SystemConfig

Mutable reference to the optional SystemConfig component associated with this system.

`Static` queries

queries: SystemQueries

Defines what GameComponent the System will query for. This needs to be user defined.

`Static` `Optional` systemConfig

systemConfig?: GameComponentConstructor<SystemConfig>

An optional SystemConfig class for configuring this system.

Accessors

assetManager

get assetManager(): AssetManager
AssetManager instance

Returns AssetManager
Inherited from GameSystem.assetManager
- Defined in src/ecs/GameSystem.ts:46

core

get core(): Core
Core object that this system is registered to.

Returns Core
Inherited from GameSystem.core
- Defined in src/ecs/GameSystem.ts:36

player

get player(): Player
Player object

Returns Player
Inherited from GameSystem.player
- Defined in src/ecs/GameSystem.ts:41

Methods

exitXR

exitXR(): void
This function is called on the frames in which the app exits immersive

Returns void
Inherited from GameSystem.exitXR
- Defined in src/ecs/GameSystem.ts:82

initXR

initXR(): void
This function is called on the frames in which the app enters immersive

Returns void
Inherited from GameSystem.initXR
- Defined in src/ecs/GameSystem.ts:79

queryAddedGameObjects

queryAddedGameObjects(queryId: string): GameObject<Object3DEventMap>[]
Get a list of all GameObject of the given queryId that are added in this frame in queries. This does not include the GameObjects that gets added in GameSystems that execute after this system.

Returns
An array of GameObject instances that were added in this frame and match the query.

Throws
An error if the query ID does not exist in the current game system or if the query does not listen to added events.
Parameters
- queryId: string
  
  The ID of the query to retrieve added game objects for.
Returns GameObject<Object3DEventMap>[]
Inherited from GameSystem.queryAddedGameObjects
- Defined in src/ecs/GameSystem.ts:119

queryGameObjects

queryGameObjects(queryId: string): GameObject<Object3DEventMap>[]
Get a list of all GameObject of the given queryId in queries.

Returns
An array of GameObject instances that match the query.

Throws
An error if the query ID does not exist in the current game system.
Parameters
- queryId: string
  
  The ID of the query to retrieve game objects for.
Returns GameObject<Object3DEventMap>[]
Inherited from GameSystem.queryGameObjects
- Defined in src/ecs/GameSystem.ts:103

queryRemovedGameObjects

queryRemovedGameObjects(queryId: string): GameObject<Object3DEventMap>[]
Get a list of all GameObject of the given queryId that are removed in this frame in queries. This does not include the GameObjects that gets removed in GameSystems that execute after this system.

Returns
An array of GameObject instances that were removed in this frame and match the query.

Throws
An error if the query ID does not exist in the current game system or if the query does not listen to removed events.
Parameters
- queryId: string
  
  The ID of the query to retrieve removed game objects for.
Returns GameObject<Object3DEventMap>[]
Inherited from GameSystem.queryRemovedGameObjects
- Defined in src/ecs/GameSystem.ts:139

update

update(_delta: number, _time: number): void
This function is called on each frame Core is executed. All of the queries defined on the class are available here.
Parameters
- _delta: number
- _time: number
Returns void
Inherited from GameSystem.update
- Defined in src/ecs/GameSystem.ts:156

Class XRGameSystem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

world: World<Entity>

Optional attributes: Attributes

Returns XRGameSystem

Properties

Optional config

Static queries

Static Optional systemConfig

Accessors

assetManager

Returns AssetManager

core

Returns Core

player

Returns Player

Methods

exitXR

Returns void

initXR

Returns void

queryAddedGameObjects

Returns

Throws

Parameters

queryId: string

Returns GameObject<Object3DEventMap>[]

queryGameObjects

Returns

Throws

Parameters

queryId: string

Returns GameObject<Object3DEventMap>[]

queryRemovedGameObjects

Returns

Throws

Parameters

queryId: string

Returns GameObject<Object3DEventMap>[]

update

Parameters

_delta: number

_time: number

Returns void

Settings

Member Visibility

Theme

`Optional` attributes: Attributes

`Optional` config

`Static` queries

`Static` `Optional` systemConfig