Applicationclass

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

Properties19

Showing 19 properties

public static ulong Sandbox.Application.AppId { get; set; }PUBLICSTATICGETSET

Steam AppId of S&box.

Returns:ulong—

public static bool Sandbox.Application.CheatsEnabled { get; set; }PUBLICSTATICGETSET

Returns:bool—

public static Editor.EditorSystem Sandbox.Application.Editor { get; set; }PUBLICSTATICGETSET

Get the current editor if any. Will return null if we're not in the editor, or there is no active editor session.

Returns:EditorSystem—

public static ulong Sandbox.Application.FrameCount { get; set; }PUBLICSTATICGETSET

Number of engine frames since startup. Increments once at the start of every frame. Starts at 1, so a default frame stamp of 0 always reads as a frame that has passed.

Returns:ulong—

public static bool Sandbox.Application.IsConsoleApp { get; set; }PUBLICSTATICGETSET

True if running in a terminal like console, instead of a game window or editor.

Returns:bool—

public static bool Sandbox.Application.IsDebug { get; set; }PUBLICSTATICGETSET

Returns:bool—

public static bool Sandbox.Application.IsDedicatedServer { get; set; }PUBLICSTATICGETSET

True if this is a dedicated server

Returns:bool—

public static bool Sandbox.Application.IsEditor { get; set; }PUBLICSTATICGETSET

True if running with the tools or editor attached

Returns:bool—

public static bool Sandbox.Application.IsFocused { get; set; }PUBLICSTATICGETSET

Is the game window in focus?

Returns:bool—

public static bool Sandbox.Application.IsHeadless { get; set; }PUBLICSTATICGETSET

True if running without a graphics window, such as in a terminal.

Returns:bool—

public static bool Sandbox.Application.IsMicrophoneListening { get; set; }PUBLICSTATICGETSET

Returns true if the microphone is currently listening

Returns:bool—

public static bool Sandbox.Application.IsMicrophoneRecording { get; set; }PUBLICSTATICGETSET

Returns true if the microphone is currently listening and actually hearing/capturing sounds

Returns:bool—

public static bool Sandbox.Application.IsStandalone { get; set; }PUBLICSTATICGETSET

True if the game is running in standalone mode

Returns:bool—

public static bool Sandbox.Application.IsUnitTest { get; set; }PUBLICSTATICGETSET

True if we're running the engine as part of a unit test

Returns:bool—

public static bool Sandbox.Application.IsVR { get; set; }PUBLICSTATICGETSET

True if the game is running in VR mode

Returns:bool—

public static string Sandbox.Application.LanguageCode { get; set; }PUBLICSTATICGETSET

The language code for the current language

Returns:string—

public static Sandbox.Engine.Settings.RenderSettings Sandbox.Application.RenderSettings { get; set; }PUBLICSTATICGETSET

Allows access to the RenderSettings singleton, which contains settings related to rendering in the game. You're only able to access this when in standalone mode. When accessing in the editor, or in sbox it will return null.

Returns:RenderSettings—

public static string Sandbox.Application.Version { get; set; }PUBLICSTATICGETSET

The engine's version string

Returns:string—

public static System.DateTime Sandbox.Application.VersionDate { get; set; }PUBLICSTATICGETSET

The date of this version, as a UTC datetime.

Returns:DateTime—

On this page