TController

Adds higher level input handling

@todo

add option to unpossess

@todo

missing teardown

@todo

fix issue that controller updates actors a frame behind the input

Hierarchy

• TController
  • TSimpleController

Index

Constructors

• constructor

Properties

• isDown
• mouseLocation
• mouseMovement
• pointerLocked

Methods

• addActionFromKeyEvent
• addActionFromMouseEvent
• addAxisFromKeyEvent
• bindAction
• destroy
• enableMouseTracking
• enablePointerLock
• getAxisValue
• possess
• update

Constructors

constructor

• new TController(inputEventQueue: default): default

• Parameters

  • inputEventQueue: default

  Returns default

Properties

publicisDown

isDown: {} = {}

Type declaration

• [key string]: boolean

publicoptionalmouseLocation

mouseLocation?: TMouseLocation

publicoptionalmouseMovement

mouseMovement?: TMouseMovement

publicpointerLocked

pointerLocked: boolean = false

Methods

publicaddActionFromKeyEvent

• addActionFromKeyEvent(action: string, key: string): void

• Parameters

  • action: string

  • key: string

  Returns void

publicaddActionFromMouseEvent

• addActionFromMouseEvent(action: string, button: number): void

• Parameters

  • action: string

  • button: number

  Returns void

publicaddAxisFromKeyEvent

• addAxisFromKeyEvent(axis: string, key: string, scale: number): void

• Parameters

  • axis: string

  • key: string

  • scale: number

  Returns void

publicbindAction

• bindAction(action: string, state: string, callback: () => void): void

• Binds an action to a callback for states pressed or released.

  @todo

  throw error if state is invalid

  ---

  Parameters

  • action: string

  • state: string

  • callback: () => void

  Returns void

publicdestroy

• destroy(): void

• Tears down the controller and removes all event listeners.

  @todo

  add rest of event listeners, including pointer lock change

  ---

  Returns void

publicenableMouseTracking

• enableMouseTracking(): void

• Returns void

publicenablePointerLock

• enablePointerLock(engine: default): void

• Parameters

  • engine: default

  Returns void

publicgetAxisValue

• getAxisValue(axis: string): number

• Returns the current value of an axis or 0 if it is missing.

  ---

  Parameters

  • axis: string

    name of the axis

  Returns number

publicpossess

• possess(actor: default): void

• Parameters

  • actor: default

  Returns void

publicupdate

• update(): void

• Returns void