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 diverses options persistantes liées à la façon dont l'utilisateur contrôle sa caméra et son personnage.
Vous pouvez accéder à cet objet à partir d'un LocalScript via :
Cet objet est destiné à être utilisé sur le client seulement, car il ne sert à aucun but sur le serveur. Il reflète également vos propres paramètres lors du test dans Roblox Studio.
Échantillons de code
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 le bureau.
Le type de contrôles utilisés par le client sur le bureau.
Bascule si oui ou non le client peut utiliser le mode Switch Mouse Lock.
Décrivez à quel point la caméra est sensible lorsqu'elle est utilisée sur un gamepad.
Un flot entre 0 et 1 représentant le volume du client du jeu.
Un flot entre 0 et 4 représentant la sensibilité de la sensibilité de la caméra du client.
Contrôle la façon dont le personnage du client est rotaté.
Le niveau de qualité des graphiques 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 inversée de la caméra.
Vérifie si l'onboarding a été terminé.
Retourne vrai si la fenêtre Roblox de l'utilisateur est en mode plein écran.
Retourne vrai si la session de jeu du client est dans Roblox Studio.
Si vous y êtes invité, Roblox active l'option de menu pour inverser l'axe de caméra de l'utilisateur.
Si vous l'appelez, Roblox bascule l'option de menu pour contrôler la sensibilité de la caméra avec les gamepads.
Définit l'onboarding comme terminé.
Évènements
Tire si le mode d'écran complet de l'utilisateur est changé.
Activer quand le client de l'utilisateur passe entre le mode studio et le mode en jeu. Ceci se déclenche 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 le bureau.
ComputerMovementMode
Le type de contrôles utilisés par le client sur le bureau.
Fullscreen
GamepadCameraSensitivity
Décrivez à quel point la caméra est sensible lorsqu'elle est utilisée sur un gamepad.
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Un flot 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 oui ou non l'onboarding donné a été terminé, ce qui est utile pour éviter de montrer l'animation d'onboarding à nouveau.
Si onboardingId n'est pas l'un des ID pris en charge, une erreur est lancée.
Le processus d'onboarding est un processus à sens unique. Cela signifie que, en tant que développeur, vous pouvez forcer le processus d'onboarding à la fin, mais vous ne pouvez pas le réinitialiser.
Voir aussi :
- UserGameSettings:SetOnboardingCompleted() , définit l'onboarding comme terminé
Paramètres
L'ID d'onboarding pour demander.
Retours
Que l'onboarding en particulier soit ou non terminé.
InFullScreen
Retourne vrai si la fenêtre Roblox de l'utilisateur est en mode plein écran.
Retours
SetCameraYInvertVisible
Si vous y êtes invité, Roblox active l'option de menu pour inverser l'axe de caméra de l'utilisateur.
Retours
SetGamepadCameraSensitivityVisible
Si vous l'appelez, Roblox bascule l'option de menu pour contrôler la sensibilité de la caméra avec les gamepads.
Retours
SetOnboardingCompleted
Définit l'onboarding donné comme terminé, afin qu'il ne soit plus affiché à l'utilisateur la prochaine fois qu'il jouer.
Actuellement, cette fonction ne prend que DynamicThumbstick, et il est utilisé pour suivre de manière persistante si oui ou non le joueur a terminé le tutoriel pour le schéma de contrôle Dynamic Thumbstick. Si onboardingId n'est pas l'un des ID pris en charge, une erreur est lancée.
Le processus d'onboarding est un processus à sens unique. Cela signifie que, en tant que développeur, vous pouvez forcer le processus d'onboarding à la fin, mais vous ne pouvez pas le réinitialiser.
Voir aussi :
- UserGameSettings:GetOnboardingCompleted() , vérifie si l'onboarding a été terminé
Paramètres
L'ID d'onboarding à définir comme terminé.
Retours
Évènements
FullscreenChanged
Tire si le mode plein écran de l'utilisateur est changé. L'événement ne tirera que sur les appareils de bureau qui peuvent basculer le mode plein écran. Le jeu sera toujours en mode plein écran sur les appareils mobiles et les consoles.
Paramètres
Échantillons de code
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
Activer quand le client de l'utilisateur passe entre le mode studio et le mode en jeu. Ceci se déclenche périodiquement dans Roblox Studio lorsqu'une session commence.