UserGameSettings
*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.
The UserGameSettings adalah kelas tunggal yang ditemukan di dalam singleton UserSettings tunggal.Ini menyimpan berbagai pengaturan permanen yang berkaitan dengan bagaimana pengguna ingin mengontrol kamera dan karakter mereka.
Anda dapat mengakses objek ini dari LocalScript melalui:
Objek ini dimaksudkan untuk digunakan hanya pada klien, karena tidak memiliki tujuan di server.Ini juga akan mencerminkan pengaturan Anda sendiri saat menguji di Roblox Studio.
Contoh Kode
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)Rangkuman
Properti
Mode gerakan kamera saat ini sedang digunakan oleh klien di desktop.
Jenis kontrol yang digunakan oleh klien di desktop.
Mengubah apakah klien dapat menggunakan mode Mouse Lock Switch atau tidak.
Menggambarkan seberapa sensitif kamera saat menggunakan gamepad.
Sebuah float antara 0 dan 1 yang mewakili volume klien game.
Pengapung antara 0 dan 4 yang mewakili sensitivitas sensitivitas kamera klien.
Mengontrol bagaimana karakter klien diputar.
Tingkat kualitas grafis yang ditetapkan oleh klien.
Jenis kamera yang digunakan oleh klien saat berada di perangkat seluler.
Jenis kontrol yang digunakan oleh klien di perangkat seluler.
Metode
Kembalikan nilai Y-invert kamera.
Memeriksa apakah onboarding telah selesai.
Kembalikan benar jika jendela Roblox pengguna berada dalam mode layar penuh.
Kembalikan benar jika sesi permainan klien berada di Roblox Studio.
Jika dipanggil, Roblox mengubah opsi menu untuk membalikkan sumbu kamera pengguna.
Jika dipanggil, Roblox menyalakan opsi menu untuk mengontrol sensitivitas kamera dengan gamepad.
Mengatur onboarding sebagai selesai.
Acara
Memicu jika mode layar penuh pengguna diubah.
Ditembak ketika klien pengguna beralih antara mode Studio dan mode dalam game. Ini ditembak secara berkala di Roblox Studio saat sesi dimulai.
Properti
AllTutorialsDisabled
CameraMode
ChatVisible
ComputerCameraMovementMode
Mode gerakan kamera saat ini sedang digunakan oleh klien di desktop.
ControlMode
Mengubah apakah klien dapat menggunakan mode Mouse Lock Switch atau tidak.
Fullscreen
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
MouseSensitivity
Pengapung antara 0 dan 4 yang mewakili sensitivitas sensitivitas kamera klien.
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
Jenis kamera yang digunakan oleh klien saat berada di perangkat seluler.
TouchMovementMode
Jenis kontrol yang digunakan oleh klien di perangkat seluler.
UsedCoreGuiIsVisibleToggle
UsedCustomGuiIsVisibleToggle
UsedHideHudShortcut
VREnabled
VRRotationIntensity
VRSmoothRotationEnabled
VignetteEnabled
Metode
GetOnboardingCompleted
Memeriksa apakah atau tidak onboarding yang diberikan telah selesai, yang berguna untuk menghindari menampilkan animasi onboarding lagi.
Jika onboardingId bukan salah satu ID yang diterima, kesalahan terjadi.
Proses onboarding adalah satu arah. Ini berarti bahwa, sebagai pengembang, Anda dapat memaksa proses onboarding selesai tetapi tidak dapat mengatur ulang.
Lihat juga:
- UserGameSettings:SetOnboardingCompleted() , menetapkan onboarding sebagai selesai
Parameter
ID onboarding untuk ditanyakan.
Memberikan nilai
Apakah atau tidak onboarding khususnya telah selesai belum.
InFullScreen
Kembalikan benar jika jendela Roblox pengguna berada dalam mode layar penuh.
Memberikan nilai
InStudioMode
Kembalikan benar jika sesi permainan klien berada di Roblox Studio.
Memberikan nilai
SetCameraYInvertVisible
Jika dipanggil, Roblox mengubah opsi menu untuk membalikkan sumbu kamera pengguna.
Memberikan nilai
SetGamepadCameraSensitivityVisible
Jika dipanggil, Roblox menyalakan opsi menu untuk mengontrol sensitivitas kamera dengan gamepad.
Memberikan nilai
SetOnboardingCompleted
Atur onboarding yang diberikan selesai, sehingga tidak akan ditampilkan lagi kepada pengguna saat berikutnya mereka bermain.
Saat ini, fungsi ini hanya menerima DynamicThumbstick , dan digunakan untuk terus-menerus melacak apakah pemain telah menyelesaikan tutorial untuk skema kontrol Dynamic Thumbstick atau tidak.Jika onboardingId bukan salah satu ID yang diterima, kesalahan terjadi.
Proses onboarding adalah satu arah. Ini berarti bahwa, sebagai pengembang, Anda dapat memaksa proses onboarding selesai tetapi tidak dapat mengatur ulang.
Lihat juga:
- UserGameSettings:GetOnboardingCompleted() , memeriksa apakah onboarding telah selesai
Parameter
ID onboarding untuk disetel sebagai selesai.
Memberikan nilai
Acara
FullscreenChanged
Memicu jika mode layar penuh pengguna diubah.Acara hanya akan menembak di perangkat desktop yang dapat beralih mode layar penuh.Permainan akan selalu berada di layar penuh di perangkat seluler dan konsol.
Parameter
Contoh Kode
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
Ditembak ketika klien pengguna beralih antara mode Studio dan mode dalam game. Ini ditembak secara berkala di Roblox Studio saat sesi dimulai.