s&box docs
API Referenceglobal

Lineclass

A subtitle line being spoken right now - a playing sound's subtitle track sampled at its playback time. Get these from `Sandbox.SubtitlesGameObjectSystem.GetActive(System.Collections.Generic.List)`.

object→Line
Namespace
global
Assembly
Sandbox.Engine
Declaration
public sealed struct Sandbox.SubtitlesGameObjectSystem.Line

Properties4

Showing 4 properties

public int Sandbox.SubtitlesGameObjectSystem.Line.CurrentWordIndex { get; set; }PUBLICGETSET

Index into `Sandbox.SubtitleTrack.Words` of the latest word to have started, or -1 before the first word. Words up to here have been spoken - that's the karaoke highlight.

Returns:int—

public Sandbox.SoundHandle Sandbox.SubtitlesGameObjectSystem.Line.Sound { get; set; }PUBLICGETSET

The sound speaking this line, or null for subtitles injected with `Sandbox.SubtitlesGameObjectSystem.Show(System.String,System.Single)`. May have finished - lines hang around for a moment after their sound ends.

Returns:SoundHandle—

public float Sandbox.SubtitlesGameObjectSystem.Line.Time { get; set; }PUBLICGETSET

How far into the line we are, in seconds - the sound's playback time, or time since `Sandbox.SubtitlesGameObjectSystem.Show(System.String,System.Single)` for injected subtitles.

Returns:float—

Related Guides

→Style Properties

ConvertAttribute.ctor()

Previous Page

CurrentWordIndex

Next Page

On this page

Propertiespublic System.Int32 Sandbox.SubtitlesGameObjectSystem.Line.CurrentWordIndex { get; set; }public Sandbox.SoundHandle Sandbox.SubtitlesGameObjectSystem.Line.Sound { get; set; }public System.Single Sandbox.SubtitlesGameObjectSystem.Line.Time { get; set; }public Sandbox.SubtitleTrack Sandbox.SubtitlesGameObjectSystem.Line.Track { get; set; }Metadata