s&box docs
API ReferenceSandbox

Preferencesclass

Holds information about the current user's preferences.

object→Preferences
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public static abstract sealed class Sandbox.Preferences

Properties13

Showing 13 properties

public static bool Sandbox.Preferences.ChatEnabled { get; set; }PUBLICSTATICGETSET

Returns:bool—

public static float Sandbox.Preferences.ControllerJoystickDeadzone { get; set; }PUBLICSTATICGETSET

The percentage of joystick travel ignored around the neutral position.

Returns:float—

public static float Sandbox.Preferences.ControllerLookPitchSpeed { get; set; }PUBLICSTATICGETSET

Returns:float—

public static float Sandbox.Preferences.ControllerLookYawSpeed { get; set; }PUBLICSTATICGETSET

Returns:float—

public static float Sandbox.Preferences.FieldOfView { get; set; }PUBLICSTATICGETSET

The user's preference for their field of view

Returns:float—

public static bool Sandbox.Preferences.InvertMousePitch { get; set; }PUBLICSTATICGETSET

Returns:bool—

public static bool Sandbox.Preferences.InvertMouseYaw { get; set; }PUBLICSTATICGETSET

Returns:bool—

public static float Sandbox.Preferences.MusicVolume { get; set; }PUBLICSTATICGETSET

The user's preferred Music volume, as set in the options, clamped between 0 and 1

Returns:float—

public static float Sandbox.Preferences.Sensitivity { get; set; }PUBLICSTATICGETSET

The mouse sensitivity

Returns:float—

public static bool Sandbox.Preferences.StreamerMode { get; set; }PUBLICSTATICGETSET

When enabled, player usernames/avatars are replaced with anonymous versions.

Returns:bool—

public static bool Sandbox.Preferences.Subtitles { get; set; }PUBLICSTATICGETSET

Whether the user wants to see subtitles for sounds that have them. Off by default - turned on in the audio settings.

Returns:bool—

public static float Sandbox.Preferences.VoipVolume { get; set; }PUBLICSTATICGETSET

The user's preferred VOIP volume, as set in the options, clamped between 0 and 1

Returns:float—

Related Guides

→Editor Events

PrefabVariable.ctor()

Previous Page

ChatEnabled

Next Page

On this page

Propertiespublic static System.Boolean Sandbox.Preferences.ChatEnabled { get; set; }public static System.Single Sandbox.Preferences.ControllerJoystickDeadzone { get; set; }public static System.Single Sandbox.Preferences.ControllerLookPitchSpeed { get; set; }public static System.Single Sandbox.Preferences.ControllerLookYawSpeed { get; set; }public static System.Single Sandbox.Preferences.FieldOfView { get; set; }public static System.Boolean Sandbox.Preferences.InvertMousePitch { get; set; }public static System.Boolean Sandbox.Preferences.InvertMouseYaw { get; set; }public static System.Single Sandbox.Preferences.MusicVolume { get; set; }public static System.Single Sandbox.Preferences.Sensitivity { get; set; }public static System.Boolean Sandbox.Preferences.StreamerMode { get; set; }public static System.Boolean Sandbox.Preferences.Subtitles { get; set; }public static Sandbox.VoiceMode Sandbox.Preferences.VoiceMode { get; set; }public static System.Single Sandbox.Preferences.VoipVolume { get; set; }Metadata