UserGameSettings
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Le UserGameSettings est une classe singleton trouvée à l'intérieur du singleton UserSettings.Il contient divers paramètres persistants relatifs à la façon dont l'utilisateur souhaite contrôler sa caméra et son personnage.
Vous pouvez accéder à cet objet à partir d'un LocalScript via :
Cet objet est destiné à être utilisé uniquement sur le client, car il n'a pas d'objectif sur le serveur.Il reflètera également vos propres paramètres lors des tests dans Roblox Studio.
Échantillons de code
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.
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
Le mode de déplacement de la caméra actuellement utilisé par le client sur bureau.
Le type de contrôles utilisés par le client sur le bureau.
Active ou désactive l'utilisation du mode verrouillage de la souris par le client.
Décrit à quel point la caméra est sensible lorsqu'elle utilise une manette de jeu.
Une flotte entre 0 et 1 représentant le volume du client du jeu.
Une flotte entre 0 et 4 représentant la sensibilité de la sensibilité de la caméra du client.
Contrôle la manière dont le caractère du client est roté.
Le niveau de qualité graphique défini par le client.
Le type de caméra utilisé par le client lorsqu'il est sur un appareil mobile.
Le type de contrôles utilisés par le client sur un appareil mobile.
Méthodes
Renvoie la valeur Y d'inversion de la caméra.
Vérifie si l'intégration est terminée.
Renvoie vrai si la fenêtre Roblox de l'utilisateur est en mode plein écran.
Renvoie vrai si la session de jeu du client est dans Roblox Studio.
Si appelé, Roblox active l'option de menu pour inverser l'axe de la caméra de l'utilisateur.
Si appelé, Roblox bascule l'option du menu pour contrôler la sensibilité de la caméra avec les manettes de jeu.
Définir l'embarquement comme terminé.
Évènements
Se déclenche si le mode plein écran de l'utilisateur est modifié.
Tiré lorsque le client de l'utilisateur passe d'un mode Studio à un mode en jeu. Cela se produit périodiquement dans Roblox Studio lorsqu'une session commence.
Propriétés
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
Le mode de déplacement de la caméra actuellement utilisé par le client sur bureau.
ComputerMovementMode
Le type de contrôles utilisés par le client sur le bureau.
ControlMode
Active ou désactive l'utilisation du mode verrouillage de la souris par le client.
Fullscreen
GamepadCameraSensitivity
Décrit à quel point la caméra est sensible lorsqu'elle utilise une manette de jeu.
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Une flotte entre 0 et 4 représentant la sensibilité de la sensibilité de la caméra du client.
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
Le type de caméra utilisé par le client lorsqu'il est sur un appareil mobile.
TouchMovementMode
Le type de contrôles utilisés par le client sur un appareil mobile.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Méthodes
GetOnboardingCompleted
Vérifie si l'onboarding donné a été terminé ou non, ce qui est utile pour éviter de montrer à nouveau l'animation d'onboarding.
Si onboardingId n'est pas l'un des ID acceptés, une erreur est lancée.
Le processus d'embarquement est unilatéral. Cela signifie que, en tant que développeur, vous pouvez forcer le processus d'embarquement à la fin, mais vous ne pouvez pas le réinitialiser.
Voir aussi :
- UserGameSettings:SetOnboardingCompleted() , définit l'embarquement comme terminé
Paramètres
L'ID d'embarquement à interroger.
Retours
Si l'onboarding en particulier a été achevé ou non.
InFullScreen
Renvoie vrai si la fenêtre Roblox de l'utilisateur est en mode plein écran.
Retours
InStudioMode
Renvoie vrai si la session de jeu du client est dans Roblox Studio.
Retours
SetCameraYInvertVisible
Si appelé, Roblox active l'option de menu pour inverser l'axe de la caméra de l'utilisateur.
Retours
SetGamepadCameraSensitivityVisible
Si appelé, Roblox bascule l'option du menu pour contrôler la sensibilité de la caméra avec les manettes de jeu.
Retours
SetOnboardingCompleted
Définit l'onboarding donné comme terminé, afin qu'il ne soit pas à nouveau affiché à l'utilisateur la prochaine fois qu'il jouer.
Actuellement, cette fonction n'accepte que DynamicThumbstick, et elle est utilisée pour suivre de manière persistante si le joueur a terminé ou non le tutoriel pour le schéma de contrôle Dynamic Thumbstick.Si onboardingId n'est pas l'un des ID acceptés, une erreur est lancée.
Le processus d'embarquement est unilatéral. Cela signifie que, en tant que développeur, vous pouvez forcer le processus d'embarquement à la fin, mais vous ne pouvez pas le réinitialiser.
Voir aussi :
- UserGameSettings:GetOnboardingCompleted() , vérifie si l'intégration a été terminée
Paramètres
L'ID d'embarquement à définir comme terminé.
Retours
Évènements
FullscreenChanged
Se déclenche si le mode plein écran de l'utilisateur est modifié.L'événement ne se déclenchera que sur les appareils de bureau qui peuvent activer le mode plein écran.Le jeu sera toujours en plein écran sur les appareils mobiles et les consoles.
Paramètres
Échantillons de code
A LocalScript that demonstrates how you can detect whether a game is in full screen or not.
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
Tiré lorsque le client de l'utilisateur passe d'un mode Studio à un mode en jeu. Cela se produit périodiquement dans Roblox Studio lorsqu'une session commence.