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

Méthodes

Évènements

Propriétés

AllTutorialsDisabled

Lecture parallèle
Sécurité des scripts Roblox
Lecture parallèle
Sécurité des scripts Roblox

ChatVisible

Lecture parallèle
Sécurité des scripts Roblox

ComputerCameraMovementMode

Lecture parallèle

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

ComputerMovementMode

Lecture parallèle

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

ControlMode

Lecture parallèle

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

Fullscreen

Lecture parallèle
Sécurité des scripts Roblox

GamepadCameraSensitivity

Lecture parallèle

Describes how sensitive the camera is when using a gamepad.

GraphicsOptimizationMode

Lecture parallèle
Sécurité des scripts Roblox

GraphicsQualityLevel

Lecture parallèle
Sécurité des scripts Roblox

HasEverUsedVR

Lecture parallèle
Sécurité des scripts Roblox

MasterVolume

Lecture parallèle
Sécurité des scripts Roblox

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

MasterVolumeStudio

Lecture parallèle
Sécurité des scripts Roblox

MaxQualityEnabled

Lecture parallèle
Sécurité des scripts Roblox

MouseSensitivity

Lecture parallèle

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

OnboardingsCompleted

Lecture parallèle
Sécurité des scripts Roblox

PartyVoiceVolume

Lecture parallèle
Sécurité des scripts Roblox

RCCProfilerRecordFrameRate

Lecture parallèle

RCCProfilerRecordTimeFrame

Lecture parallèle

RotationType

Lecture parallèle

Controls how the client's character is rotated.

SavedQualityLevel

Lecture parallèle

The graphics quality level set by the client.

StartMaximized

Non répliqué
Non scriptable
Lecture parallèle
Sécurité des scripts Roblox

StartScreenPosition

Non répliqué
Non scriptable
Lecture parallèle
Sécurité des scripts Roblox

StartScreenSize

Non répliqué
Non scriptable
Lecture parallèle
Sécurité des scripts Roblox

TouchCameraMovementMode

Lecture parallèle

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

TouchMovementMode

Lecture parallèle

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

UsedCoreGuiIsVisibleToggle

Lecture parallèle
Sécurité des scripts Roblox

UsedCustomGuiIsVisibleToggle

Lecture parallèle
Sécurité des scripts Roblox

UsedHideHudShortcut

Lecture parallèle
Sécurité des scripts Roblox

VREnabled

Lecture parallèle
Sécurité des scripts Roblox

VRRotationIntensity

Lecture parallèle
Sécurité des scripts Roblox

VRSmoothRotationEnabled

Lecture parallèle
Sécurité des scripts Roblox

VignetteEnabled

Lecture parallèle
Sécurité des scripts Roblox

Méthodes

GetCameraYInvertValue

Returns the camera's Y-invert value.


Retours

GetOnboardingCompleted

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.

See also:

Paramètres

onboardingId: string

The onboarding ID to inquire about.


Retours

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

InFullScreen

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


Retours

InStudioMode

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


Retours

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.

See also:

Paramètres

onboardingId: string

The onboarding ID to set as completed.


Retours

void

É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