UserSettings

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Création impossible

UserSettings est un objet singleton qui est utilisé pour héberger les paramètres utilisateur basiques, qui persistent dans tous les jeux.Actuellement, il ne stocke que l'objet UserGameSettings.

Vous pouvez récupérer une référence à cet objet via la fonction UserSettings(), qui le renvoie.

Échantillons de code

A basic sample of how the IsUserFeatureEnabled function is used by Roblox to control certain features.

IsUserFeatureEnabled Sample

if UserSettings():IsUserFeatureEnabled("UserNoCameraClickToMove") then
	print("'ClickToMove' should no longer be loaded from the CameraScript!")
else
	print("'ClickToMove' is still loaded from the CameraScript!")
end

A LocalScript that demonstrates how you can detect whether a game is in full screen or not.

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)

A basic example that shows how you can listen to changes in the user's settings. With this code pasted into a LocalScript running in the StarterPlayerScripts, you can change settings in Roblox's game menu, and see their values appear in the output as detected changes.

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

Afficher tous les hérités de Instance

Afficher tous les hérités de Object

Méthodes

IsUserFeatureEnabled(name : string):boolean
Renvoie vrai si la fonctionnalité utilisateur spécifiée est activée. Cela provoquera une erreur si la fonctionnalité utilisateur n'existe pas.
Reset():()
Efface l'état sauvegardé des paramètres d'utilisateur et restaure ses valeurs par défaut.

Méthodes hérités de ServiceProvider

FindService(className : string):Instance
Écrire en parallèle
Renvoie le service spécifié par le className donné s'il est déjà créé, des erreurs pour un nom invalide.
GetService(className : string):Instance
Retourne le service avec le nom de classe demandé, le créant s'il n'existe pas.

Afficher tous les hérités de Instance

Afficher tous les hérités de Object

Évènements

Évènements hérités de ServiceProvider

Close():RBXScriptSignal
Se déclenche lorsque l'endroit actuel est quitté.
ServiceAdded(service : Instance):RBXScriptSignal
Déployé lorsqu'un service est créé.
ServiceRemoving(service : Instance):RBXScriptSignal
Tiré lorsqu'un service est sur le point d'être supprimé.

Afficher tous les hérités de Instance

Afficher tous les hérités de Object

Propriétés

Afficher tous les hérités de Instance

Afficher tous les hérités de Object

Méthodes

IsUserFeatureEnabled

boolean

Renvoie vrai si la fonctionnalité utilisateur spécifiée est activée. Cela provoquera une erreur si la fonctionnalité utilisateur n'existe pas.

Cette fonction vérifie contre une liste de FFlags, dont le nom commence par "utilisateur".La fonction est destinée à être utilisée par des scripts créés par Roblox et fonctionne de manière similaire à GlobalSettings:GetFFlag().

Paramètres

name: string

Valeur par défaut : ""

Retours

boolean

Échantillons de code

A basic sample of how the IsUserFeatureEnabled function is used by Roblox to control certain features.

IsUserFeatureEnabled Sample

if UserSettings():IsUserFeatureEnabled("UserNoCameraClickToMove") then
	print("'ClickToMove' should no longer be loaded from the CameraScript!")
else
	print("'ClickToMove' is still loaded from the CameraScript!")
end

Reset

()

Efface l'état sauvegardé des paramètres d'utilisateur et restaure leurs valeurs par défaut.Cette fonction échouera à s'exécuter correctement à partir d'un script local, car elle n'a pas la permission de restaurer toutes les propriétés de la classe UserGameSettings.