Home Reference Source 
import InputSystem from 'oxygen-core/systems/InputSystem.js'
public class | source

InputSystem

Extends:

System → InputSystem

User input (mouse, keyboard, gamepad).

Example:

const system = new InputSystem(document.getElementById('screen-0'));

Constructor Summary

Public Constructor
public

constructor(canvas: HTMLCanvasElement, triggerEvents: boolean)

Constructor.

Member Summary

Public Members
public get
public get
public get
public get

Method Summary

Public Methods
public
public

onKeyDown(event: *)

public

onKeyUp(event: *)

public

onMouseDown(event: *, target: *)

public

onMouseMove(event: *, target: *)

public

onMouseUp(event: *, target: *)

public
public

onTouchDown(event: *, target: *)

public

onTouchMove(event: *, target: *)

public

onTouchUp(event: *, target: *)

public
public

Scan for changes in browser gamepads list.

Inherited Summary

From class System
public static get
public static get

systems: *

public static

Dispose and remove all registered systems.
public static

get(typename: string): System | null

Returns system instance of given type name.
public static

register(typename: string, system: System): System

Register new system instance under given name.
public static

unregister(typename: string): System

Unregister given system.
public

Destructor (disposes all internal resources).
public

Event called after system gets registered.
public

Event called before system gets unregistered.

Public Constructors

public constructor(canvas: HTMLCanvasElement, triggerEvents: boolean) source

Constructor.

Params:

NameTypeAttributeDescription
canvas HTMLCanvasElement

Canvas element to listen for events from.
triggerEvents boolean

Tells if system should trigger events.

Public Members

public get events: Events source

Override:

System#events

public get gamepads: Map source

public get isTouchDevice: boolean source

public get triggerEvents: boolean source

Public Methods

public dispose() source

Dispose and remove all registered systems.

Override:

System#dispose

public onKeyDown(event: *) source

Params:

NameTypeAttributeDescription
event *

public onKeyUp(event: *) source

Params:

NameTypeAttributeDescription
event *

public onMouseDown(event: *, target: *) source

Params:

NameTypeAttributeDescription
event *
target *

public onMouseMove(event: *, target: *) source

Params:

NameTypeAttributeDescription
event *
target *

public onMouseUp(event: *, target: *) source

Params:

NameTypeAttributeDescription
event *
target *

public onRegister() source

Event called after system gets registered.

Override:

System#onRegister

public onTouchDown(event: *, target: *) source

Params:

NameTypeAttributeDescription
event *
target *

public onTouchMove(event: *, target: *) source

Params:

NameTypeAttributeDescription
event *
target *

public onTouchUp(event: *, target: *) source

Params:

NameTypeAttributeDescription
event *
target *

public onUnregister() source

Event called before system gets unregistered.

Override:

System#onUnregister

public scanForGamepads() source

Scan for changes in browser gamepads list.