Class Player

This class extends THREE.Object3D

See

https://threejs.org/docs/#api/en/core/Object3D

Hierarchy

GameObject
- Player

Index

Constructors

Properties

Accessors

alive controllers head

Methods

addComponent clone copy destroy getComponent getComponentTypes getComponents getComponentsToRemove getMutableComponent getRemovedComponent hasAllComponents hasAnyComponents hasComponent removeAllComponents removeComponent update updateMatrixWorld

Constructors

constructor

new Player(): Player
Returns Player
Overrides GameObject.constructor
- Defined in src/xr/Player.ts:18

Properties

isGameObject

isGameObject: boolean = true

Accessors

alive

get alive(): boolean
Returns boolean
Inherited from GameObject.alive
- Defined in src/ecs/GameObject.ts:45

controllers

get controllers(): Record<XRHandedness, XRController>
Returns Record<XRHandedness, XRController>
- Defined in src/xr/Player.ts:28

head

get head(): GameObject<Object3DEventMap>
Accurate source for player head transform, can be used to attach game objects / audio listeners.

Returns GameObject<Object3DEventMap>
- Defined in src/xr/Player.ts:36

Methods

addComponent

addComponent(GameComponent: GameComponentConstructor<GameComponent<any>>, values?: Partial<Omit<GameComponent<any>, keyof GameComponent<any>>>): void
Add a GameComponent to the entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
- Optional values: Partial<Omit<GameComponent<any>, keyof GameComponent<any>>>
Returns void
Inherited from GameObject.addComponent
- Defined in src/ecs/GameObject.ts:58

clone

clone(_recursive?: boolean): Player
Parameters
- Optional _recursive: boolean
Returns Player
Inherited from GameObject.clone
- Defined in src/ecs/GameObject.ts:53

copy

copy(_source: Player, _recursive?: boolean): Player
Parameters
- _source: Player
- Optional _recursive: boolean
Returns Player
Inherited from GameObject.copy
- Defined in src/ecs/GameObject.ts:49

destroy

destroy(forceImmediate?: boolean): void
Destroy this GameObject
Parameters
- forceImmediate: boolean = false
Returns void
Inherited from GameObject.destroy
- Defined in src/ecs/GameObject.ts:152

getComponent

getComponent(GameComponent: GameComponentConstructor<GameComponent<any>>, includeRemoved?: boolean): Readonly<GameComponent<any>>
Get an immutable reference to a GameComponent on this entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
- Optional includeRemoved: boolean
Returns Readonly<GameComponent<any>>
Inherited from GameObject.getComponent
- Defined in src/ecs/GameObject.ts:69

getComponentTypes

getComponentTypes(): Component<any>[]
Get a list of GameComponent types that have been added to this entity.

Returns Component<any>[]
Inherited from GameObject.getComponentTypes
- Defined in src/ecs/GameObject.ts:87

getComponents

getComponents(): {
[componentName: string]: Component<any>;
}
Get an object containing all the GameComponent on this entity, where the object keys are the component types.

Returns {
[componentName: string]: Component<any>;
}
- [componentName: string]: Component<any>
Inherited from GameObject.getComponents
- Defined in src/ecs/GameObject.ts:95

getComponentsToRemove

getComponentsToRemove(): {
[componentName: string]: Component<any>;
}
Get an object containing all the GameComponent that are slated to be removed from this entity, where the object keys are the component types.

Returns {
[componentName: string]: Component<any>;
}
- [componentName: string]: Component<any>
Inherited from GameObject.getComponentsToRemove
- Defined in src/ecs/GameObject.ts:103

getMutableComponent

getMutableComponent(GameComponent: GameComponentConstructor<GameComponent<any>>): GameComponent<any>
Get an mutable reference to a GameComponent on this entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
Returns GameComponent<any>
Inherited from GameObject.getMutableComponent
- Defined in src/ecs/GameObject.ts:77

getRemovedComponent

getRemovedComponent(GameComponent: GameComponentConstructor<GameComponent<any>>): Readonly<GameComponent<any>>
Get a GameComponent that is slated to be removed from this entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
Returns Readonly<GameComponent<any>>
Inherited from GameObject.getRemovedComponent
- Defined in src/ecs/GameObject.ts:108

hasAllComponents

hasAllComponents(GameComponents: GameComponentConstructor<any>[]): boolean
Boolean value indicating whether the entity has all GameComponent in a list.
Parameters
- GameComponents: GameComponentConstructor<any>[]
Returns boolean
Inherited from GameObject.hasAllComponents
- Defined in src/ecs/GameObject.ts:118

hasAnyComponents

hasAnyComponents(GameComponents: GameComponentConstructor<any>[]): boolean
Boolean value indicating whether the entity has any GameComponent in a list.
Parameters
- GameComponents: GameComponentConstructor<any>[]
Returns boolean
Inherited from GameObject.hasAnyComponents
- Defined in src/ecs/GameObject.ts:126

hasComponent

hasComponent(GameComponent: GameComponentConstructor<any>): boolean
Boolean value indicating whether the entity has the given GameComponent.
Parameters
- GameComponent: GameComponentConstructor<any>
Returns boolean
Inherited from GameObject.hasComponent
- Defined in src/ecs/GameObject.ts:134

removeAllComponents

removeAllComponents(forceImmediate: boolean): void
Remove all GameComponent on this entity.
Parameters
- forceImmediate: boolean
Returns void
Inherited from GameObject.removeAllComponents
- Defined in src/ecs/GameObject.ts:139

removeComponent

removeComponent(GameComponent: GameComponentConstructor<any>, forceImmediate: boolean): void
Remove a GameComponent from the entity.
Parameters
- GameComponent: GameComponentConstructor<any>
- forceImmediate: boolean
Returns void
Inherited from GameObject.removeComponent
- Defined in src/ecs/GameObject.ts:144

update

update(xrManager: WebXRManager): void
Parameters
- xrManager: WebXRManager
Returns void
- Defined in src/xr/Player.ts:44

updateMatrixWorld

updateMatrixWorld(force?: boolean): void
Parameters
- Optional force: boolean
Returns void
Overrides GameObject.updateMatrixWorld
- Defined in src/xr/Player.ts:40