Class Core

Hierarchy

Core

Accessors

RAPIER

get RAPIER(): __module
Returns __module
- Defined in src/ecs/Core.ts:68

assetManager

get assetManager(): AssetManager
Returns AssetManager
- Defined in src/ecs/Core.ts:64

camera

get camera(): PerspectiveCamera
Returns PerspectiveCamera
- Defined in src/ecs/Core.ts:56

globals

get globals(): Map<string, any>
Global data store

Returns Map<string, any>
- Defined in src/ecs/Core.ts:73

initialized

get initialized(): boolean
Returns boolean
- Defined in src/ecs/Core.ts:77

player

get player(): Player
Returns Player
- Defined in src/ecs/Core.ts:60

renderer

get renderer(): WebGLRenderer
Returns WebGLRenderer
- Defined in src/ecs/Core.ts:52

scene

get scene(): Scene
Returns Scene
- Defined in src/ecs/Core.ts:48

sessionMode

get sessionMode(): "inline" | "immersive-vr" | "immersive-ar"
Enum value indicating the current XRSessionMode

Returns "inline" | "immersive-vr" | "immersive-ar"
- Defined in src/ecs/Core.ts:82

Methods

getGameSystem

getGameSystem(GameSystem: GameSystemConstructor<any>): any
Get a GameSystem registered in this world.
Parameters
- GameSystem: GameSystemConstructor<any>
Returns any
- Defined in src/ecs/Core.ts:136

getGameSystemConfig

getGameSystemConfig(GameSystem: GameSystemConstructor<GameSystem>): SystemConfig
Get the mutable SystemConfig component associated with the specified GameSystem.
Parameters
- GameSystem: GameSystemConstructor<GameSystem>
Returns SystemConfig
- Defined in src/ecs/Core.ts:144

getGameSystems

getGameSystems(): System<Entity>[]
Get a list of GameSystem registered in this world.

Returns System<Entity>[]
- Defined in src/ecs/Core.ts:151

hasRegisteredGameComponent

hasRegisteredGameComponent(GameComponent: GameComponentConstructor<any>): boolean
Boolean value indicating whether a GameComponent has been registered to Core or not.
Parameters
- GameComponent: GameComponentConstructor<any>
Returns boolean
- Defined in src/ecs/Core.ts:164

isImmersive

isImmersive(): boolean
Boolean value for whether player is in immersive mode.

Returns boolean
- Defined in src/ecs/Core.ts:116

play

play(): void
Resume execution of registered systems.

Returns void
- Defined in src/ecs/Core.ts:174

registerGameComponent

registerGameComponent(GameComponent: GameComponentConstructor<any>): void
Register a GameComponent
Parameters
- GameComponent: GameComponentConstructor<any>
Returns void
- Defined in src/ecs/Core.ts:156

registerGameSystem

registerGameSystem(GameSystem: GameSystemConstructor<any>, attributes?: Attributes): void
Register a GameSystem.
Parameters
- GameSystem: GameSystemConstructor<any>
- attributes: Attributes = {}
Returns void
- Defined in src/ecs/Core.ts:121

stop

stop(): void
Pause execution of registered systems.

Returns void
- Defined in src/ecs/Core.ts:179

unregisterGameSystem

unregisterGameSystem(GameSystem: GameSystemConstructor<any>): void
Unregister a GameSystem.
Parameters
- GameSystem: GameSystemConstructor<any>
Returns void
- Defined in src/ecs/Core.ts:169

`Static` getInstance

getInstance(): Core
Returns Core
- Defined in src/ecs/Core.ts:103

`Static` init

init(): Core
Returns Core
- Defined in src/ecs/Core.ts:95