Skip to content

five-on-it / apps/client/src/ui/settings / Settings

Interface: Settings ​

Defined in: apps/client/src/ui/settings.ts:24

The player's settings.

Properties ​

camera ​

camera: number

Defined in: apps/client/src/ui/settings.ts:48

The camera's height over the player, 0.7 to 1.5 times the game's.


consentAsked ​

consentAsked: boolean

Defined in: apps/client/src/ui/settings.ts:70

The player answered the first start's question about them (the consent dialog).


crashReports ​

crashReports: boolean

Defined in: apps/client/src/ui/settings.ts:66

Crash reports are sent (telemetry.ts): off until the player says yes.


effects ​

effects: number

Defined in: apps/client/src/ui/settings.ts:30

The effects' volume (the engine, the tyres, the siren, the horn, the menus), 0..1.


hud ​

hud: boolean

Defined in: apps/client/src/ui/settings.ts:44

The HUD block is shown.


invertWheel ​

invertWheel: boolean

Defined in: apps/client/src/ui/settings.ts:42

The wheel cycles the targets on the line of fire the other way.


joinAddress ​

joinAddress: string

Defined in: apps/client/src/ui/settings.ts:62

The address of the last game joined on the network (192.168.1.23:7777); empty before one.


keys ​

keys: Partial<Record<Action, string[]>>

Defined in: apps/client/src/ui/settings.ts:64

The keys the player bound to actions other than their defaults (bindings.ts): only what differs.


lookAhead ​

lookAhead: number

Defined in: apps/client/src/ui/settings.ts:40

How far the view leans toward the cursor on foot, 0 (not at all) to 2 (twice the game's).


master ​

master: number

Defined in: apps/client/src/ui/settings.ts:26

The volume of everything, 0..1.


minimap ​

minimap: number

Defined in: apps/client/src/ui/settings.ts:46

The minimap's size, 0.6 to 1.6 times the game's.


music ​

music: number

Defined in: apps/client/src/ui/settings.ts:28

The music's volume, 0..1.


nightBrightness ​

nightBrightness: number

Defined in: apps/client/src/ui/settings.ts:58

How light the night stays, a share of the day's light: 0.25 (dark) to 1 (as bright as day).


platform ​

platform: string

Defined in: apps/client/src/ui/settings.ts:60

The platform API's address (https://play.example.com/api); empty for the page's own, or the build's.


radio ​

radio: number

Defined in: apps/client/src/ui/settings.ts:32

The radio's volume, 0..1.


radioAutoOn ​

radioAutoOn: boolean

Defined in: apps/client/src/ui/settings.ts:34

Getting into a car turns its radio on (audio/radio.ts).


radioOnFoot ​

radioOnFoot: boolean

Defined in: apps/client/src/ui/settings.ts:36

The radio plays on after getting out of a car, through earbuds, and can be tuned on foot.


radioStation ​

radioStation: string

Defined in: apps/client/src/ui/settings.ts:38

The id of the station last picked (riverbend-fm); empty before one.


speedZoom ​

speedZoom: boolean

Defined in: apps/client/src/ui/settings.ts:50

In a car the camera zooms out at speed (renderer/camera.ts's SpeedZoom).


speedZoomResponse ​

speedZoomResponse: number

Defined in: apps/client/src/ui/settings.ts:54

How quickly it follows the speed, 0.5 to 2 times the game's.


speedZoomStrength ​

speedZoomStrength: number

Defined in: apps/client/src/ui/settings.ts:52

How much farther out it is at full speed: a share of its height at standstill, 0 (none) to 1 (twice as high).


textPace ​

textPace: number

Defined in: apps/client/src/ui/settings.ts:56

How long notices and messages stay on screen, 0.5 to 2 times the game's.


usageStats ​

usageStats: boolean

Defined in: apps/client/src/ui/settings.ts:68

Anonymous usage statistics are sent: off until the player says yes.