Class SubtitleDataEntry

Namespace

Gasimo.Subtitles

Assembly

Gasimo.Subtitler.dll

Contains data for 1 line of dialogue.

[Serializable]
public class SubtitleDataEntry : ISubtitleEntry

Inheritance

object

SubtitleDataEntry

Implements

ISubtitleEntry

Fields

audio

AudioClip which will play simultaneously with the subtitle line. Can be left empty to not play sound.

public AudioClip audio

Field Value

AudioClip

dialogue

Written Closed-Captions

public string dialogue

Field Value

string

displayFor

How long will this subtitle be displayed for.

public float displayFor

Field Value

float

speaker

Display name of speaker/object which plays the dialogue. Leave empty for none (useful for sounds).

[SerializeField]
public string speaker

Field Value

string

subtitleEvent

Programmable event which gets ivoked when this subtitle gets played. Useful to trigger mechanics exactly when player hears a certain line.

public ScriptableEvent subtitleEvent

Field Value

ScriptableEvent

waitFor

Delay between last Subtitle line and this one. Leave 0 to play at same time as previous line.

public float waitFor

Field Value

float

Methods

getAudio()

AudioClip of the subtitle

public AudioClip getAudio()

Returns

AudioClip

AudioClip with sound for this entry

getDialogue()

Dialogue string of the subtitle

public string getDialogue()

Returns

string

Dialogue

getDisplayFor()

How long should the subtitle be visible for?

public float getDisplayFor()

Returns

float

getSpeaker()

Speaker name for the subtitle, will prefix the dialogue in this format: speaker:dialogue (Optional)

public string getSpeaker()

Returns

string

Speaker Name

getSubtitleEvent()

public ScriptableEvent getSubtitleEvent()

Returns

ScriptableEvent

getWaitFor()

How long should subtitler pause before playing this line? (If in sequence, relative to last played subtitle)

public float getWaitFor()

Returns

float