s&box docs
API ReferenceSandbox

PlatformSettingsclass

Platform-level settings for a game project. These control engine-provided features like text chat that exist outside of any specific scene.

object→ConfigData→PlatformSettings
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.PlatformSettings : Sandbox.ConfigData

Constructors1

Showing 1 constructors

Properties4

Showing 4 properties

public bool Sandbox.PlatformSettings.ChatEnabled { get; set; }PUBLICGETSET

Whether the built-in text chat system is enabled for this game.

Returns:bool—

public int Sandbox.PlatformSettings.ChatMaxMessageLength { get; set; }PUBLICGETSET

Maximum length of a single chat message in characters.

Returns:int—

public bool Sandbox.PlatformSettings.ChatShowUI { get; set; }PUBLICGETSET

Show the default chat UI overlay. When false, messages are still processed and events still fire, but the built-in overlay is hidden. Use this when implementing a custom chat UI.

Returns:bool—

public bool Sandbox.PlatformSettings.SubtitlesShowUI { get; set; }PUBLICGETSET

Show the default subtitle UI overlay for sounds with subtitle tracks. When false, the tracks still load and `Sandbox.SubtitlesGameObjectSystem.GetActive(System.Collections.Generic.List)` still works, but the built-in overlay is hidden. Use this when implementing a custom subtitle UI.

Returns:bool—

PlaneCollider.ctor()

Previous Page

ChatEnabled

Next Page

On this page

Constructorspublic PlatformSettings()Propertiespublic System.Boolean Sandbox.PlatformSettings.ChatEnabled { get; set; }public System.Int32 Sandbox.PlatformSettings.ChatMaxMessageLength { get; set; }public System.Boolean Sandbox.PlatformSettings.ChatShowUI { get; set; }public System.Boolean Sandbox.PlatformSettings.SubtitlesShowUI { get; set; }Metadata