@relu-interactives/spatial-ecs

---

@relu-interactives/spatial-ecs / index / InputSystem

Class: InputSystem

Defined in: systems/InputSystem.ts:32

Implements

• EcsSystem

Constructors

Constructor

new InputSystem(): InputSystem;

Defined in: systems/InputSystem.ts:186

Returns

InputSystem

Methods

setPointerLockElement()

setPointerLockElement(element): void;

Defined in: systems/InputSystem.ts:202

Parameters

Parameter	Type
element	HTMLElement | null

Returns

void

---

lockMousePointer()

lockMousePointer(): boolean;

Defined in: systems/InputSystem.ts:206

Returns

boolean

---

unlockMousePointer()

unlockMousePointer(): boolean;

Defined in: systems/InputSystem.ts:233

Returns

boolean

---

isMousePointerLocked()

isMousePointerLocked(): boolean;

Defined in: systems/InputSystem.ts:249

Returns

boolean

---

getKey()

getKey(key): boolean;

Defined in: systems/InputSystem.ts:266

Parameters

Parameter	Type
key	string

Returns

boolean

---

getKeyDown()

getKeyDown(key): boolean;

Defined in: systems/InputSystem.ts:270

Parameters

Parameter	Type
key	string

Returns

boolean

---

getKeyUp()

getKeyUp(key): boolean;

Defined in: systems/InputSystem.ts:274

Parameters

Parameter	Type
key	string

Returns

boolean

---

consumePressed()

consumePressed(key): boolean;

Defined in: systems/InputSystem.ts:278

Parameters

Parameter	Type
key	string

Returns

boolean

---

getMouse()

getMouse(button): boolean;

Defined in: systems/InputSystem.ts:288

Parameters

Parameter	Type
button	string | number

Returns

boolean

---

getMouseDown()

getMouseDown(button): boolean;

Defined in: systems/InputSystem.ts:297

Parameters

Parameter	Type
button	string | number

Returns

boolean

---

getMouseUp()

getMouseUp(button): boolean;

Defined in: systems/InputSystem.ts:306

Parameters

Parameter	Type
button	string | number

Returns

boolean

---

getScrollClick()

getScrollClick(): boolean;

Defined in: systems/InputSystem.ts:315

Returns

boolean

---

getScrollClickDown()

getScrollClickDown(): boolean;

Defined in: systems/InputSystem.ts:319

Returns

boolean

---

getScrollClickUp()

getScrollClickUp(): boolean;

Defined in: systems/InputSystem.ts:323

Returns

boolean

---

getScrollDelta()

getScrollDelta(): {
  x: number;
  y: number;
};

Defined in: systems/InputSystem.ts:327

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
x	number	systems/InputSystem.ts:327
y	number	systems/InputSystem.ts:327

---

consumeScrollDelta()

consumeScrollDelta(): {
  x: number;
  y: number;
};

Defined in: systems/InputSystem.ts:334

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
x	number	systems/InputSystem.ts:334
y	number	systems/InputSystem.ts:334

---

getMousePosition()

getMousePosition(): {
  x: number;
  y: number;
};

Defined in: systems/InputSystem.ts:341

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
x	number	systems/InputSystem.ts:341
y	number	systems/InputSystem.ts:341

---

getMouseDelta()

getMouseDelta(): {
  x: number;
  y: number;
};

Defined in: systems/InputSystem.ts:348

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
x	number	systems/InputSystem.ts:348
y	number	systems/InputSystem.ts:348

---

consumeMouseDelta()

consumeMouseDelta(): {
  x: number;
  y: number;
};

Defined in: systems/InputSystem.ts:355

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
x	number	systems/InputSystem.ts:355
y	number	systems/InputSystem.ts:355

---

update()

update(_world, _deltaTime): void;

Defined in: systems/InputSystem.ts:362

Parameters

Parameter	Type
_world	World
_deltaTime	number

Returns

void

Implementation of

EcsSystem.update

---

dispose()

dispose(): void;

Defined in: systems/InputSystem.ts:398

Returns

void

Implementation of

EcsSystem.dispose