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 Class.UserSettings. Ini menyimpan berbagai pengaturan yang bertahan lama berhubungan dengan cara pengguna ingin mengendalikan kamera mereka, dan karakter mereka.
Anda dapat mengakses objek ini dari a LocalScript melalui:
Objek ini dimaksudkan untuk digunakan hanya pada klien, karena tidak ada tujuan pada server. Ini juga akan mencerminkan pengaturan Anda sendiri saat diuji 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 atau tidak klien dapat menggunakan mode Mouse Lock Switch.
Menggambarkan seberapa sensitif kamera saat menggunakan gamepad.
Pengapung antara 0 dan 1 mewakili volume klien game.
Float antara 0 dan 4 mewakili sensitivitas kamera klien.
Mengontrol cara karakter klien diputar.
Tingkat kualitas grafis yang ditetapkan oleh klien.
Jenis kamera yang digunakan oleh klien saat menggunakan perangkat seluler.
Jenis kontrol yang digunakan oleh klien di perangkat seluler.
Metode
Mengembalikan nilai Y kamera.
Memeriksa apakah onboarding telah selesai.
Mengembalikan benar jika jendela Roblox pengguna berada dalam mode layar penuh.
Mengembalikan benar jika sesi permainan klien berada di Roblox Studio.
Jika diaktifkan, Roblox mengubah opsi menu untuk mengubah sumbu kamera pengguna.
Jika diaktifkan, Roblox mengubah opsi menu untuk mengontrol sensitivitas kamera dengan gamepad.
Tetapkan onboarding sebagai selesai.
Acara
Menembak jika mode layar penuh pengguna diubah.
Diaktifkan saat klien pengguna beralih antara mode studio dan mode dalam game. Ini diaktifkan secara periodik 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 atau tidak klien dapat menggunakan mode Mouse Lock Switch.
Fullscreen
GraphicsOptimizationMode
GraphicsQualityLevel
HasEverUsedVR
MasterVolumeStudio
MaxQualityEnabled
OnboardingsCompleted
PartyVoiceVolume
RCCProfilerRecordFrameRate
RCCProfilerRecordTimeFrame
StartMaximized
StartScreenPosition
StartScreenSize
TouchCameraMovementMode
Jenis kamera yang digunakan oleh klien saat menggunakan 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 menunjukkan animasi onboarding lagi.
Jika onboardingId bukan salah satu ID yang diterima, kesalahan dijatuhkan.
Proses onboarding satu arah. Ini berarti bahwa, sebagai pengembang, Anda dapat mengatur proses onboarding ke selesai tetapi tidak dapat mengatur ulangnya.
Lihat juga:
- UserGameSettings:SetOnboardingCompleted() , menetapkan onboarding sebagai selesai
Parameter
ID onboarding untuk ditanyakan.
Memberikan nilai
Apakah atau tidak onboarding khusus telah selesai.
InFullScreen
Mengembalikan benar jika jendela Roblox pengguna berada dalam mode layar penuh.
Memberikan nilai
InStudioMode
Mengembalikan benar jika sesi permainan klien berada di Roblox Studio.
Memberikan nilai
SetCameraYInvertVisible
Jika diaktifkan, Roblox mengubah opsi menu untuk mengubah sumbu kamera pengguna.
Memberikan nilai
SetGamepadCameraSensitivityVisible
Jika diaktifkan, Roblox mengubah opsi menu untuk mengontrol sensitivitas kamera dengan gamepad.
Memberikan nilai
SetOnboardingCompleted
Tetapkan onboarding yang diberikan sebagai selesai, sehingga tidak akan ditunjukkan lagi kepada pengguna lain kali mereka bermain.
Saat ini, fungsi ini hanya menerima DynamicThumbstick, dan digunakan untuk secara konsisten melacak apakah atau tidak pemain telah menyelesaikan tutorial untuk konsrol Dynamic Thumbstick. Jika onboardingId bukan salah satu ID yang diterima, kesalahan dijatuhkan.
Proses onboarding satu arah. Ini berarti bahwa, sebagai pengembang, Anda dapat mengatur proses onboarding ke selesai tetapi tidak dapat mengatur ulangnya.
Lihat juga:
- UserGameSettings:GetOnboardingCompleted() , memeriksa apakah onboarding telah selesai
Parameter
ID onboarding untuk diatur sebagai selesai.
Memberikan nilai
Acara
FullscreenChanged
Menembak jika mode layar penuh pengguna diubah. Acara ini hanya akan menembak di perangkat desktop yang dapat mengubah mode layar penuh. Game ini akan selalu berada di layar penuh di perangkat mobile 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
Diaktifkan saat klien pengguna beralih antara mode studio dan mode dalam game. Ini diaktifkan secara periodik di Roblox Studio saat sesi dimulai.