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
SubtitlesGameObjectSystem
chevron_left Classes
class
SubtitlesGameObjectSystem

Constructors

functionsSubtitlesGameObjectSystem

Methods

functionsGetActivefunctionsShow
SubtitlesGameObjectSystem
Knows which subtitle lines are being spoken in this scene right now. Sounds carry their own subtitle tracks (Sandbox.SoundFile.Subtitles, authored in the sound editor) - Sandbox.SubtitlesGameObjectSystem.GetActive(System.Collections.Generic.List{Sandbox.SubtitlesGameObjectSystem.Line}) samples the ones playing in this scene. The built-in overlay renders them word by word; to draw your own UI instead, turn off "Show UI" in the project's platform settings and build it on this system.
class Sandbox .account_tree extends GameObjectSystem<T>
sealedSandbox.Engine

build Constructors 1

SubtitlesGameObjectSystem (scene)

functions Methods 2

GetActive (lines)
Show (text, duration)
Show a subtitle that isn't attached to a sound - scripted dialogue, a radio voice you're streaming, whatever. The text is split into words spread over the duration, so it highlights word by word like a sound's subtitle track does. Main thread only.

Inheritance

GameObjectSystem
GameObjectSystem<T>
SubtitlesGameObjectSystem
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.