UserGameSettings

Mostrar obsoleto

não criável

configurações do usuário

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.

Amostras de código

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)

Resumo

Propriedades

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

Ver todos os herdados de Instance

Métodos

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.

Ver todos os herdados de Instance

Eventos

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.

Ver todos os herdados de Instance

Propriedades

AllTutorialsDisabled

bool

ler parallel

segurança do script roblox

CameraMode

Enum.CustomCameraMode

ler parallel

segurança do script roblox

ChatVisible

bool

ler parallel

segurança do script roblox

ComputerCameraMovementMode

Enum.ComputerCameraMovementMode

ler parallel

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

ComputerMovementMode

Enum.ComputerMovementMode

ler parallel

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

ControlMode

Enum.ControlMode

ler parallel

DESCONTINUADO

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

ler parallel

segurança do script roblox

GamepadCameraSensitivity

number

ler parallel

Describes how sensitive the camera is when using a gamepad.

GraphicsQualityLevel

number

ler parallel

segurança do script roblox

HasEverUsedVR

bool

ler parallel

segurança do script roblox

MasterVolume

number

ler parallel

segurança do script roblox

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

MasterVolumeStudio

number

ler parallel

segurança do script roblox

MouseSensitivity

number

ler parallel

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

OnboardingsCompleted

string

ler parallel

segurança do script roblox

RCCProfilerRecordFrameRate

number

ler parallel

RCCProfilerRecordTimeFrame

number

ler parallel

RotationType

Enum.RotationType

ler parallel

Controls how the client's character is rotated.

SavedQualityLevel

Enum.SavedQualitySetting

ler parallel

The graphics quality level set by the client.

StartMaximized

bool

não replicado

não scriptável

ler parallel

segurança do script roblox

StartScreenPosition

Vector2

não replicado

não scriptável

ler parallel

segurança do script roblox

StartScreenSize

Vector2

não replicado

não scriptável

ler parallel

segurança do script roblox

TouchCameraMovementMode

Enum.TouchCameraMovementMode

ler parallel

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

TouchMovementMode

Enum.TouchMovementMode

ler parallel

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

UsedCoreGuiIsVisibleToggle

bool

ler parallel

segurança do script roblox

UsedCustomGuiIsVisibleToggle

bool

ler parallel

segurança do script roblox

UsedHideHudShortcut

bool

ler parallel

segurança do script roblox

VREnabled

bool

ler parallel

segurança do script roblox

VRRotationIntensity

number

ler parallel

segurança do script roblox

VRSmoothRotationEnabled

bool

ler parallel

segurança do script roblox

VignetteEnabled

bool

ler parallel

segurança do script roblox

Ver todos os herdados de Instance

Métodos

GetCameraYInvertValue

number

Returns the camera's Y-invert value.

Devolução

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.

Parâmetros

onboardingId: string

The onboarding ID to inquire about.

Devolução

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.

Devolução

bool

InStudioMode

bool

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

Devolução

bool

SetCameraYInvertVisible

void

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

Devolução

void

SetGamepadCameraSensitivityVisible

void

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

Devolução

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.

Parâmetros

onboardingId: string

The onboarding ID to set as completed.

Devolução

void

Ver todos os herdados de Instance

Eventos

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.

Parâmetros

isFullscreen: bool

Amostras de código

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.

Parâmetros

isStudioMode: bool

Ver todos os herdados de Instance