useVirtualControls

@zylem/game-lib

---

@zylem/game-lib / input / useVirtualControls

Function: useVirtualControls()

useVirtualControls(player, options?): GameInputConfig

Defined in: packages/game-lib/src/lib/input/input-presets.ts:172

Enables virtual touch controls for the given player. By default the provider auto-enables itself on mobile/touch devices.

Parameters

player

"p1" | "p3" | "p4" | "p2" | "p6" | "p5" | "p7" | "p8"

options?

VirtualTouchConfig

Returns

GameInputConfig

Example

stage.setInputConfiguration(useVirtualControls('p1'));