Class Input

Classdesc

Input class, used for handling input

Example

const input = new Input("w", 100);
input.on = (event) => {
     console.log("w pressed");
}
input.activate(scene);

Constructors

constructor

Properties

active clickMonitor fireInterval fireRate firing id key on

Methods

activate deactivate reactivate startFiring stopFiring

Constructors

constructor

  • new Input(key, fireRate): Input

  • Parameters

    • key: string

      The key that the input is bound to ("click" is you want to monitor clicks)

    • fireRate: number

      How often the input fires (in ms)

    Returns Input

Properties

active

active: boolean

Whether or not the input is active

clickMonitor

clickMonitor: boolean

Whether or not the input is a click monitor

fireInterval

fireInterval: any

Interval that the input fires on

fireRate

fireRate: number

Fire rate of the input

firing

firing: boolean

Whether or not the input is firing

id

id: string

Unique ID of the input

key

key: string

Key that the input is bound to

on

on: Function

Function to run when the input is fired (EventOnFunction)

Methods

activate

  • activate(activateOn?): void

  • Activates the input monitor

    Parameters

    • Optional activateOn: Scene

      Scene to activate the input on (Only matters if the input is a click monitor)

    Returns void

deactivate

  • deactivate(): void

  • Temporarily deactivates the input monitor

    Returns void

reactivate

  • reactivate(): void

  • Reactivates the input monitor (if it was deactivated- do not use input.active(scene) as this will cause the on function to be called twice every fireRate ms)

    Returns void

startFiring

  • startFiring(e): void

  • Starts firing the on function ever fireRate ms

    Parameters

    • e: Event

      Event to pass to the on function

    Returns void

stopFiring

  • stopFiring(): void

  • Stops firing the on function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc