infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
Classes
PlatformSettings
chevron_left Classes
class
PlatformSettings

Constructors

functionsPlatformSettings

Properties

data_objectChatEnableddata_objectChatMaxMessageLengthdata_objectChatShowUIdata_objectSubtitlesShowUI
PlatformSettings
Platform-level settings for a game project. These control engine-provided features like text chat that exist outside of any specific scene.
class Sandbox .account_tree extends ConfigData
Sandbox.Engine

build Constructors 1

PlatformSettings ()

data_object Properties 4

ChatEnabled
bool
Whether the built-in text chat system is enabled for this game.
ChatMaxMessageLength
int
Maximum length of a single chat message in characters.
ChatShowUI
bool
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.
SubtitlesShowUI
bool
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{Sandbox.SubtitlesGameObjectSystem.Line}) still works, but the built-in overlay is hidden. Use this when implementing a custom subtitle UI.

Inheritance

ConfigData
PlatformSettings
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.