SettingsState

Extends

• PlayerSettings

Properties

Property	Type	Description
autoGainControl	boolean	Whether the browser keeps her voice at an even level.
cameraShake	number	How much a game’s big moments shake the camera, 0 to 100: 100 is the game’s own, 0 none. Reduced motion turns it off.
changeSetting	<Key>(key, value) => void	Sets one setting; a number outside its row’s range is clamped.
effectsVolume	number	Every other sound, 0 to 100, under the master.
fieldOfView	number | null	The degrees the camera sees across a 16:9 screen, 60 to 120, within the range the game’s camera allows; null keeps the game’s own.
frameRateCap	number | null	The most frames a second the game draws, which the engine applies as the nearest whole divisor of the screen’s refresh rate, so frames stay evenly paced; null draws every frame the screen offers.
fullscreenOnPlay	boolean	Whether the click on Play also goes fullscreen.
grassSway	boolean | null	Whether the grass sways in the wind; null follows the quality level, which sways it at Medium and High unless motion is reduced.
interfaceVolume	number	Menu and HUD sounds, such as a button’s click or a card turning, 0 to 100, under the master.
invertLook	boolean	Whether moving the mouse up looks down.
keepReplay	boolean	Whether a development build keeps a replay of the play for an agent to find a moment in. A production build keeps none, whatever this says.
masterVolume	number	Every sound, 0 to 100: the slider’s position, which the engine hears in decibels, so 0 is silent and every 20 points is 10 dB.
microphoneVolume	number	Her microphone’s level before it is sent, 0 to 100, on the volumes’ decibel curve.
mouseSensitivity	number	A multiplier on the camera’s look speed, 0.001 to 100: 1 is the game’s own.
musicVolume	number	Music and ambience, 0 to 100, under the master.
noiseSuppression	boolean	Whether the browser takes steady noise out of her microphone.
performanceStats	PerformanceStatsMode	How much of the frame rate, frame time, ping and room step shows.
pushToTalkKey	string | null	Her talk key, as KeyboardEvent.code; null keeps the game’s, the engine’s pushToTalk action, V unless the game moves it.
reducedMotion	boolean | null	Whether the interface moves less; null follows the device’s own setting.
resetSettings	(keys?) => void	Puts keys back to their defaults, or every setting when none are named: one Settings tab’s reset, or all of them.
setDefaultVoiceMode	(mode) => void	Makes mode the game’s voice mode, which a reset returns to, and sets it where this device has saved none: Game’s defaultVoiceMode calls it. undefined puts back the engine’s.
setDefaultVolumes	(volumes) => void	Makes volumes the game’s defaults, which a reset returns to, and sets each one this device has not saved: Game’s defaultVolumes calls it.
shiftLock	boolean	Whether Shift turns the camera’s lock on and off, in a game whose camera lets it.
showPlayerNames	boolean	Whether other players’ names show over their heads, in a game that draws them.
voiceMode	VoiceMode	What her talk key does: held to talk, or pressed to turn her microphone on and off.
voiceSensitivity	number	With open mic, the level her microphone sends from, in dBFS, -80 to -10. No row shows it: the engine ships one tuned threshold.
voiceVolume	number	The other players’ voices, 0 to 200: 100 plays them as they send, and past 100 up to 6 dB louder, as Roblox’s voice slider runs to twice.