Class SubtitleManagerExtensions

Namespace

SkyrimForge.Game

Assembly

SkyrimForge.Game.dll

Provides extension members for SubtitleManager.

public static class SubtitleManagerExtensions

Inheritance

object

SubtitleManagerExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

AddSubtitle<TSpeaker>(SubtitleManager, TSpeaker, string, float, bool)

Shows text as a subtitle under speaker.

public static void AddSubtitle<TSpeaker>(this SubtitleManager manager, TSpeaker speaker, string text, float distance = 0, bool forceDisplay = true) where TSpeaker : notnull, IObjectReference

Parameters

manager SubtitleManager

speaker TSpeaker

The speaker.

text string

The subtitle text.

distance float

The entry's target distance.

forceDisplay bool

Whether the entry shows regardless of distance.

Type Parameters

TSpeaker

Remarks

The subtitle remains until RemoveSubtitle removes it, or until one of the speaker's own lines ends, which removes all of the speaker's subtitles. While the dialogue menu is open, the Dialogue Menu also shows the line of the speaker in conversation.

Exceptions

ArgumentNullException

text is null.

RemoveSubtitle<TSpeaker>(SubtitleManager, TSpeaker, string, MenuTopicManager)

Removes every subtitle showing text under speaker.

public static int RemoveSubtitle<TSpeaker>(this SubtitleManager manager, TSpeaker speaker, string text, MenuTopicManager menuTopicManager) where TSpeaker : notnull, IObjectReference

Parameters

manager SubtitleManager

speaker TSpeaker

The speaker.

text string

The subtitle text.

menuTopicManager MenuTopicManager

The game's dialogue state, which decides whether the Dialogue Menu shows the line.

Returns

int

The number of entries removed.

Type Parameters

TSpeaker

Exceptions

ArgumentNullException

text is null.