Class Player

Hierarchy

GameObject
- Player

Index

Constructors

Properties

active componentMask isGameObject

Accessors

controllers head

Methods

addComponent clone copy destroy getComponent getComponentTypes hasComponent removeComponent update updateMatrixWorld

Constructors

constructor

new Player(world: World): Player
Parameters
- world: World
Returns Player
Overrides GameObject.constructor
- Defined in src/xr/Player.ts:19

Properties

active

active: boolean = true

componentMask

componentMask: number = 0

`Readonly` isGameObject

isGameObject: boolean = true

Accessors

controllers

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

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:37

Methods

addComponent

addComponent<T>(componentClass: T, initialData?: {
[key: string]: any;
}): Component
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
- initialData: {
  [key: string]: any;
  } = {}
  - [key: string]: any
Returns Component
Inherited from GameObject.addComponent
- Defined in src/ecs/GameObject.ts:46

clone

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

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:38

destroy

destroy(): void
Returns void
Inherited from GameObject.destroy
- Defined in src/ecs/GameObject.ts:102

getComponent

getComponent<T>(componentClass: {
    bitmask: number;
    defaults: {
        [key: string]: any;
    };
    new (_cm: ComponentManager, _mi: number): T;
}): T
Type Parameters
- T extends Component<T>
Parameters
- componentClass: {
      bitmask: number;
      defaults: {
          [key: string]: any;
      };
      new (_cm: ComponentManager, _mi: number): T;
  }
  - - new (_cm: ComponentManager, _mi: number): T
    - Parameters
      
      _cm: ComponentManager
      
      _mi: number
      
      Returns T
  - bitmask: number
  - defaults: {
    [key: string]: any;
    }
    - [key: string]: any
Returns T
Inherited from GameObject.getComponent
- Defined in src/ecs/GameObject.ts:86

getComponentTypes

getComponentTypes(): typeof Component[]
Returns typeof Component[]
Inherited from GameObject.getComponentTypes
- Defined in src/ecs/GameObject.ts:97

hasComponent

hasComponent<T>(componentClass: T): boolean
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns boolean
Inherited from GameObject.hasComponent
- Defined in src/ecs/GameObject.ts:81

removeComponent

removeComponent<T>(componentClass: T): void
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns void
Inherited from GameObject.removeComponent
- Defined in src/ecs/GameObject.ts:65

update

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

updateMatrixWorld

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