TSimpleController

TSimpleController can be used as a drop-in controller for simple games.

It follows a common pattern used in a number of games.

Hierarchy

• default
  • TSimpleController
    • TTopDownController

Index

Constructors

• constructor

Properties

• isDown
• mouseLocation
• mouseMovement
• pointerLocked

Methods

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

Constructors

constructor

• new TSimpleController(eventQueue: default): default

• Overrides default.constructor

  Parameters

  • eventQueue: default

  Returns default

Properties

publicisDown

isDown: {} = {}

Inherited from default.isDown

Type declaration

• [key string]: boolean

publicoptionalmouseLocation

mouseLocation?: TMouseLocation

Inherited from default.mouseLocation

publicoptionalmouseMovement

mouseMovement?: TMouseMovement

Inherited from default.mouseMovement

publicpointerLocked

pointerLocked: boolean = false

Inherited from default.pointerLocked

Methods

publicaddActionFromKeyEvent

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

• Inherited from default.addActionFromKeyEvent

  Parameters

  • action: string

  • key: string

  Returns void

publicaddActionFromMouseEvent

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

• Inherited from default.addActionFromMouseEvent

  Parameters

  • action: string

  • button: number

  Returns void

publicaddAxisFromKeyEvent

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

• Inherited from default.addAxisFromKeyEvent

  Parameters

  • axis: string

  • key: string

  • scale: number

  Returns void

publicbindAction

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

• Inherited from default.bindAction

  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

• Inherited from default.destroy

  Tears down the controller and removes all event listeners.

  @todo

  add rest of event listeners, including pointer lock change

  ---

  Returns void

publicenableMouseTracking

• enableMouseTracking(): void

• Inherited from default.enableMouseTracking

  Returns void

publicenablePointerLock

• enablePointerLock(engine: default): void

• Inherited from default.enablePointerLock

  Parameters

  • engine: default

  Returns void

publicgetAxisValue

• getAxisValue(axis: string): number

• Inherited from default.getAxisValue

  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

• Inherited from default.possess

  Parameters

  • actor: default

  Returns void

publicupdate

• update(): void

• Inherited from default.update

  Returns void