Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

readCameraShakeScale

readCameraShakeScale(playerSettings, deviceReducedMotion?): number

The share of a game’s camera shake the player sees: her Screen shake setting, and none while motion is reduced, by her Reduced motion row or, where she left it to the device, by the device’s own setting. The Xbox accessibility guidelines ask for a way to turn shake off, and WCAG’s guidance on motion from interaction points to the device’s setting. shakeCamera applies it; a game that moves its view its own way for a hit multiplies by it: readCameraShakeScale(useSettings.getState()).

Parameter Type
playerSettings Pick<PlayerSettings, "cameraShake" | "reducedMotion">
deviceReducedMotion boolean

number