i-input overview

---

Table of contents

• utils
• IInput (class)
  • start (method)
  • stop (method)
  • startInternal (method)
  • stopInternal (method)
  • stop$ (property)

---

utils

IInput (class)

An abstract class that provides basic implementation for Input class. Input is an entity for handling input from user, such as mouse movements, key presses etc. Inputs are not bound to World-s and working independently by design.

TStartParams - A type representing an array of input arguments for the start method. Items are recommended to be named.

TStopParams - A type representing an array of input arguments for the stop method. Items are recommended to be named.

Signature

export declare class IInput<TStartParams, TStopParams>

start (method)

A method that starts the input. Do not override it

Signature

start(...args: TStartParams): void

stop (method)

A method that stops the input. Do not override it

Signature

stop(...args: TStopParams): void

startInternal (method)

An abstract method that starts the input.

Signature

protected abstract startInternal(...args: TStartParams): void;

stopInternal (method)

A method that stops the input.

Signature

protected stopInternal(...args: TStopParams): void

stop$ (property)

A protected subject that emits a void value when the process is stopped. Subclasses, when subscribing to something using rxjs, have to add pipe takeUntil(this.stop$), so everything will be unsubscribed when stopping input

Signature

readonly stop$: any