UserGameSettings

Afficher les obsolètes

création impossible

paramètres de l'utilisateur

The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.

You can access this object from a LocalScript via:


UserSettings():GetService("UserGameSettings")

This object is intended to be used on the client only, as it serves no purpose on the server. It will also reflect your own settings when testing in Roblox Studio.

Échantillons de code

UserGameSettings Listener

local gameSettings = UserSettings().GameSettings

local function onGameSettingChanged(nameOfSetting)
	-- Fetch the value of this setting through a pcall to make sure we can retrieve it.
	-- Sometimes the event fires with properties that LocalScripts can't access.
	local canGetSetting, setting = pcall(function()
		return gameSettings[nameOfSetting]
	end)

	if canGetSetting then
		print("Your " .. nameOfSetting .. " has changed to: " .. tostring(setting))
	end
end

gameSettings.Changed:Connect(onGameSettingChanged)

Résumé

Propriétés

AllTutorialsDisabled:bool
lecture parallèle
CameraMode:Enum.CustomCameraMode
lecture parallèle
ChatVisible:bool
lecture parallèle
ComputerCameraMovementMode:Enum.ComputerCameraMovementMode
lecture parallèle
The camera movement mode currently in-use by the client on desktop.
ComputerMovementMode:Enum.ComputerMovementMode
lecture parallèle
The type of controls being used by the client on desktop.
ControlMode:Enum.ControlMode
lecture parallèle
obsolète
Toggles whether or not the client can use the Mouse Lock Switch mode.
Fullscreen:bool
lecture parallèle
GamepadCameraSensitivity:number
lecture parallèle
Describes how sensitive the camera is when using a gamepad.
GraphicsQualityLevel:number
lecture parallèle
HasEverUsedVR:bool
lecture parallèle
MasterVolume:number
lecture parallèle
A float between 0 and 1 representing the volume of the game's client.
MasterVolumeStudio:number
lecture parallèle
MouseSensitivity:number
lecture parallèle
A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.
OnboardingsCompleted:string
lecture parallèle
RCCProfilerRecordFrameRate:number
lecture parallèle
RCCProfilerRecordTimeFrame:number
lecture parallèle
RotationType:Enum.RotationType
lecture parallèle
Controls how the client's character is rotated.
SavedQualityLevel:Enum.SavedQualitySetting
lecture parallèle
The graphics quality level set by the client.
StartMaximized:bool
non répliqué
non scriptable
lecture parallèle
StartScreenPosition:Vector2
non répliqué
non scriptable
lecture parallèle
StartScreenSize:Vector2
non répliqué
non scriptable
lecture parallèle
TouchCameraMovementMode:Enum.TouchCameraMovementMode
lecture parallèle
The camera type in-use by the client while on a mobile device.
TouchMovementMode:Enum.TouchMovementMode
lecture parallèle
The type of controls being used by the client on a mobile device.
UsedCoreGuiIsVisibleToggle:bool
lecture parallèle
UsedCustomGuiIsVisibleToggle:bool
lecture parallèle
UsedHideHudShortcut:bool
lecture parallèle
VREnabled:bool
lecture parallèle
VRRotationIntensity:number
lecture parallèle
VRSmoothRotationEnabled:bool
lecture parallèle
VignetteEnabled:bool
lecture parallèle

Afficher tous les hérités de Instance

Méthodes

GetCameraYInvertValue():number
Returns the camera's Y-invert value.
GetOnboardingCompleted(onboardingId : string):bool
Checks if onboarding has been completed.
InFullScreen():bool
Returns true if the user's Roblox window is in full screen mode.
InStudioMode():bool
Returns true if the client's game session is in Roblox Studio.
SetCameraYInvertVisible():void
If called, Roblox toggles the menu option to invert the user's camera y axis.
SetGamepadCameraSensitivityVisible():void
If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.
SetOnboardingCompleted(onboardingId : string):void
Sets onboarding as completed.

Afficher tous les hérités de Instance

Évènements

FullscreenChanged(isFullscreen : bool):RBXScriptSignal
Fires if the user's full screen mode is changed.
StudioModeChanged(isStudioMode : bool):RBXScriptSignal
Fired when the user's client switches between studio mode and in-game mode. This gets fired periodically in Roblox Studio when a session starts.

Afficher tous les hérités de Instance

Propriétés

AllTutorialsDisabled

bool

lecture parallèle

sécurité des scripts roblox

CameraMode

Enum.CustomCameraMode

lecture parallèle

sécurité des scripts roblox

ChatVisible

bool

lecture parallèle

sécurité des scripts roblox

ComputerCameraMovementMode

Enum.ComputerCameraMovementMode

lecture parallèle

The camera movement mode currently in-use by the client on desktop.

ComputerMovementMode

Enum.ComputerMovementMode

lecture parallèle

The type of controls being used by the client on desktop.

ControlMode

Enum.ControlMode

lecture parallèle

OBSOLÈTE

This property has been deprecated. You can enable mouse-locked third-person control, or "Shift Lock Mode", through the Enum.MouseBehavior in PlayerScripts:RegisterTouchCameraMovementMode() and PlayerScripts:RegisterComputerCameraMovementMode().

Toggles whether or not the client can use the Mouse Lock Switch mode.

Fullscreen

bool

lecture parallèle

sécurité des scripts roblox

GamepadCameraSensitivity

number

lecture parallèle

Describes how sensitive the camera is when using a gamepad.

GraphicsQualityLevel

number

lecture parallèle

sécurité des scripts roblox

HasEverUsedVR

bool

lecture parallèle

sécurité des scripts roblox

MasterVolume

number

lecture parallèle

sécurité des scripts roblox

A float between 0 and 1 representing the volume of the game's client.

MasterVolumeStudio

number

lecture parallèle

sécurité des scripts roblox

MouseSensitivity

number

lecture parallèle

A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.

OnboardingsCompleted

string

lecture parallèle

sécurité des scripts roblox

RCCProfilerRecordFrameRate

number

lecture parallèle

RCCProfilerRecordTimeFrame

number

lecture parallèle

RotationType

Enum.RotationType

lecture parallèle

Controls how the client's character is rotated.

SavedQualityLevel

Enum.SavedQualitySetting

lecture parallèle

The graphics quality level set by the client.

StartMaximized

bool

non répliqué

non scriptable

lecture parallèle

sécurité des scripts roblox

StartScreenPosition

Vector2

non répliqué

non scriptable

lecture parallèle

sécurité des scripts roblox

StartScreenSize

Vector2

non répliqué

non scriptable

lecture parallèle

sécurité des scripts roblox

TouchCameraMovementMode

Enum.TouchCameraMovementMode

lecture parallèle

The camera type in-use by the client while on a mobile device.

TouchMovementMode

Enum.TouchMovementMode

lecture parallèle

The type of controls being used by the client on a mobile device.

UsedCoreGuiIsVisibleToggle

bool

lecture parallèle

sécurité des scripts roblox

UsedCustomGuiIsVisibleToggle

bool

lecture parallèle

sécurité des scripts roblox

UsedHideHudShortcut

bool

lecture parallèle

sécurité des scripts roblox

VREnabled

bool

lecture parallèle

sécurité des scripts roblox

VRRotationIntensity

number

lecture parallèle

sécurité des scripts roblox

VRSmoothRotationEnabled

bool

lecture parallèle

sécurité des scripts roblox

VignetteEnabled

bool

lecture parallèle

sécurité des scripts roblox

Afficher tous les hérités de Instance

Méthodes

GetCameraYInvertValue

number

Returns the camera's Y-invert value.

Retours

number

GetOnboardingCompleted

bool

Checks whether or not the given onboarding has been completed yet, which is useful for avoiding showing the onboarding animation again.

If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

Paramètres

onboardingId: string

The onboarding ID to inquire about.

Retours

bool

Whether or not the onboarding in particular has been completed yet.

InFullScreen

bool

Returns true if the user's Roblox window is in full screen mode.

Retours

bool

InStudioMode

bool

Returns true if the client's game session is in Roblox Studio.

Retours

bool

SetCameraYInvertVisible

void

If called, Roblox toggles the menu option to invert the user's camera y axis.

Retours

void

SetGamepadCameraSensitivityVisible

void

If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.

Retours

void

SetOnboardingCompleted

void

Sets the given onboarding as completed, so it won't be shown again to the user the next time they play.

Currently, this function only accepts DynamicThumbstick, and it is used to persistently track whether or not the player has finished the tutorial for the Dynamic Thumbstick control scheme. If onboardingId is not one of the accepted IDs, an error is thrown.

The onboarding process is one-way. This means that, as a developer, you can force the onboarding process to completion but cannot reset it.

Paramètres

onboardingId: string

The onboarding ID to set as completed.

Retours

void

Afficher tous les hérités de Instance

Évènements

FullscreenChanged

Fires if the user's full screen mode is changed. The event will only fire on desktop devices that can toggle full screen mode. The game will always be in full screen on mobile devices and consoles.

Paramètres

isFullscreen: bool

Échantillons de code

Full Screen Mode Detection

local gameSettings = UserSettings().GameSettings

local function checkFullScreenMode()
	local inFullscreen = gameSettings:InFullScreen()
	if inFullscreen then
		print("Full Screen mode enabled!")
	else
		print("Full Screen mode disabled!")
	end
end

checkFullScreenMode()
gameSettings.FullscreenChanged:Connect(checkFullScreenMode)

StudioModeChanged

Fired when the user's client switches between studio mode and in-game mode. This gets fired periodically in Roblox Studio when a session starts.

Paramètres

isStudioMode: bool

Afficher tous les hérités de Instance