SystemSettingsService class
Manages the state of system wide user settings.
Signature:
export declare class SystemSettingsService extends ExternalObject
Extends: ExternalObject
Remarks
Use Runtime.getSystemSettingsService() to get an instance of this class.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SystemSettingsService class.
Methods
| Method | Modifiers | Description |
|---|---|---|
| getSystemSettingsUpdates() | Listen for changes to the user's system settings. | |
| getSystemSettingsUpdatesV2() | Listen for changes to the user's system settings. | |
| hideSystemSettings() | Hides the global settings UI rendered by the platform. | |
| showSystemSettings() | Displays a UI rendered by the platform in the bottom right of the screen for the user to modify their global settings. |
SystemSettingsService.getSystemSettingsUpdates() method
Warning: This API is now obsolete.
SystemSettingsStates.CameraEnabled and SystemSettingsStates.MicEnabled will always be true. Use SystemSettingsService.getSystemSettingsUpdatesV2() to get the actual access states for the camera and microphone.
Listen for changes to the user's system settings.
Signature:
getSystemSettingsUpdates(): Subject<SystemSettingsStates>;
Returns:
A subject emitting the changes to the states of the settings.
SystemSettingsService.getSystemSettingsUpdatesV2() method
Listen for changes to the user's system settings.
Signature:
getSystemSettingsUpdatesV2(): Subject<SystemSettingsStates>;
Returns:
A subject emitting the changes to the states of the settings
SystemSettingsService.hideSystemSettings() method
Warning: This API is now obsolete.
This does nothing as the system settings are now controlled by the pause menu.
Hides the global settings UI rendered by the platform.
Signature:
hideSystemSettings(): void;
Returns:
void
SystemSettingsService.showSystemSettings() method
Warning: This API is now obsolete.
This does nothing as the system settings are now controlled by the pause menu.
Displays a UI rendered by the platform in the bottom right of the screen for the user to modify their global settings.
Signature:
showSystemSettings(): void;
Returns:
void
Updated 12 months ago