Skip to main content

MouseConfig

@zylem/game-lib


@zylem/game-lib / core / MouseConfig

Interface: MouseConfig

Defined in: packages/game-lib/src/lib/game/game-interfaces.ts:79

Properties​

lookMode?​

optional lookMode?: "delta" | "screenCenter"

Defined in: packages/game-lib/src/lib/game/game-interfaces.ts:87

How mouse position drives look: delta (movement) or screenCenter (cursor offset from viewport center).


lookSensitivity?​

optional lookSensitivity?: number

Defined in: packages/game-lib/src/lib/game/game-interfaces.ts:91

Screen-center follow rate toward cursor-mapped target (lower = snappier; default 2).


mapping?​

optional mapping?: MouseMapping

Defined in: packages/game-lib/src/lib/game/game-interfaces.ts:81

Custom mapping from mouse actions to input properties.


maxLookDegrees?​

optional maxLookDegrees?: number

Defined in: packages/game-lib/src/lib/game/game-interfaces.ts:89

Max yaw/pitch in degrees when lookMode is screenCenter (default 45).


pointerLock?​

optional pointerLock?: boolean

Defined in: packages/game-lib/src/lib/game/game-interfaces.ts:83

Whether to capture the cursor via Pointer Lock API.


sensitivity?​

optional sensitivity?: number

Defined in: packages/game-lib/src/lib/game/game-interfaces.ts:85

Sensitivity multiplier for mouse movement (default 0.002).