Class InputGameEngineComponent

A game engine component that manages input devices.

Hierarchy (View Summary)

GameEngineComponent
- InputGameEngineComponent

Index

Constructors

Properties

attachedEngine onDeviceAdded onDeviceRemoved

Methods

addDevice getDevice getDevices onAttachedTo onDetached removeDevice

Constructors

constructor

new InputGameEngineComponent(ticker: Ticker): InputGameEngineComponent
Creates a new InputGameEngineComponent instance.
Parameters
- ticker: Ticker
  Use for polling gamepad state.
Returns InputGameEngineComponent
Overrides GameEngineComponent.constructor
- Defined in Extensions/InputSystem/InputGameEngineComponent.ts:30

Properties

`Protected`attachedEngine

attachedEngine: null | GameEngineWindow = null

`Readonly`onDeviceAdded

onDeviceAdded: Event<Device> = ...

When a device is added to the game engine component.

`Readonly`onDeviceRemoved

onDeviceRemoved: Event<Device> = ...

When a device is removed from the game engine component.

Methods

addDevice

addDevice(device: Device): void
Adds a device to the game engine component.
Parameters
- device: Device
  The device
Returns void
- Defined in Extensions/InputSystem/InputGameEngineComponent.ts:71

getDevice

getDevice<T extends Device>(deviceClass: new (...args: any[]) => T): null | T
Gets a device of a specified class inheriting Device.
Type Parameters
- T extends Device
Parameters
- deviceClass: new (...args: any[]) => T
Returns null | T
- Defined in Extensions/InputSystem/InputGameEngineComponent.ts:48

getDevices

getDevices<T extends Device>(deviceClass: new (...args: any[]) => T): T[]
Get all devices of a specified class inheriting Device.
Type Parameters
- T extends Device
Parameters
- deviceClass: new (...args: any[]) => T
Returns T[]
- Defined in Extensions/InputSystem/InputGameEngineComponent.ts:59

onAttachedTo

onAttachedTo(gameEngine: GameEngineWindow): void
Parameters
- gameEngine: GameEngineWindow
  The game engine window this component is attached to.
Returns void
Method
onAttachedTo

Description
can be overriden by subclasses to perform actions when the component is attached to the game engine.
Inherited from GameEngineComponent.onAttachedTo
- Defined in Core/GameEngineComponent.ts:16

onDetached

onDetached(): void
When the component is detached from the game engine. Need to dispose of any resources.

Returns void
Method
onDetached
Inherited from GameEngineComponent.onDetached
- Defined in Core/GameEngineComponent.ts:24

removeDevice

removeDevice(device: Device): void
Removes a device from the game engine component.
Parameters
- device: Device
Returns void
- Defined in Extensions/InputSystem/InputGameEngineComponent.ts:80