PixelCrushers.DialogueSystem.Subtitle Class Reference

Info about a line of dialogue. More...

Collaboration diagram for PixelCrushers.DialogueSystem.Subtitle:

Public Member Functions
	Subtitle (CharacterInfo speakerInfo, CharacterInfo listenerInfo, FormattedText formattedText, string sequence, string responseMenuSequence, DialogueEntry dialogueEntry)
	Initializes a new Subtitle.
	Subtitle (CharacterInfo speakerInfo, CharacterInfo listenerInfo, FormattedText formattedText, string sequence, string responseMenuSequence, DialogueEntry dialogueEntry, string entrytag)
	Initializes a new Subtitle.
Sprite	GetSpeakerPortrait ()
	Gets the speaker portrait for this line.
Sprite	GetListenerOverridePortrait ()
	Gets the listener portrait override, if it was overridden by a [picc=#] tag.

Public Attributes
CharacterInfo	speakerInfo
	Info about the speaker of this line.
CharacterInfo	listenerInfo
	Info about the listener to whom the line is being spoken.
FormattedText	formattedText
	The formatted text of the line.
string	sequence
	The sequence associated with the line.
string	responseMenuSequence
	The response menu sequence associated with the line.
DialogueEntry	dialogueEntry
	The dialogue entry that the subtitle information came from.
string	entrytag = string.Empty
	The entrytag associated with the dialogue entry.
ActiveConversationRecord	activeConversationRecord = null
	The active conversation record associated with this subtitle; useful if multiple simultaneous conversations are running and you need to distinguish them.

Detailed Description

Info about a line of dialogue.

Subtitles are created by the ConversationModel and passed by the ConversationView to a dialogue UI to be displayed and to the Sequencer to play any associated sequence.

Constructor & Destructor Documentation

Subtitle() [1/2]

PixelCrushers.DialogueSystem.Subtitle.Subtitle ( CharacterInfo  speakerInfo, CharacterInfo  listenerInfo, FormattedText  formattedText, string  sequence, string  responseMenuSequence, DialogueEntry  dialogueEntry  )

inline

Initializes a new Subtitle.

Parameters

speakerInfo	Speaker info.
listenerInfo	Listener info.
formattedText	Formatted text.
sequence	Sequence.
responseMenuSequence	Response menu sequence.
dialogueEntry	Dialogue entry.

Subtitle() [2/2]

PixelCrushers.DialogueSystem.Subtitle.Subtitle ( CharacterInfo  speakerInfo, CharacterInfo  listenerInfo, FormattedText  formattedText, string  sequence, string  responseMenuSequence, DialogueEntry  dialogueEntry, string  entrytag  )

inline

Initializes a new Subtitle.

Parameters

speakerInfo	Speaker info.
listenerInfo	Listener info.
formattedText	Formatted text.
sequence	Sequence.
responseMenuSequence	Response menu sequence.
dialogueEntry	Dialogue entry.
entrytag	Entrytag.

Member Function Documentation

GetListenerOverridePortrait()

Sprite PixelCrushers.DialogueSystem.Subtitle.GetListenerOverridePortrait ( )

inline

Gets the listener portrait override, if it was overridden by a [picc=#] tag.

If not overridden by [picc=#], returns null;

Returns

GetSpeakerPortrait()

Sprite PixelCrushers.DialogueSystem.Subtitle.GetSpeakerPortrait ( )

inline

Gets the speaker portrait for this line.

This is normally speakerInfo.portrait, but it could be overridden by [pic*] tags in the formatted text.

Returns

The speaker portrait.

Member Data Documentation

activeConversationRecord

ActiveConversationRecord PixelCrushers.DialogueSystem.Subtitle.activeConversationRecord = null

The active conversation record associated with this subtitle; useful if multiple simultaneous conversations are running and you need to distinguish them.

dialogueEntry

DialogueEntry PixelCrushers.DialogueSystem.Subtitle.dialogueEntry

The dialogue entry that the subtitle information came from.

entrytag

string PixelCrushers.DialogueSystem.Subtitle.entrytag = string.Empty

The entrytag associated with the dialogue entry.

formattedText

FormattedText PixelCrushers.DialogueSystem.Subtitle.formattedText

The formatted text of the line.

The IDialogueUI displays this text.

listenerInfo

CharacterInfo PixelCrushers.DialogueSystem.Subtitle.listenerInfo

Info about the listener to whom the line is being spoken.

responseMenuSequence

string PixelCrushers.DialogueSystem.Subtitle.responseMenuSequence

The response menu sequence associated with the line.

If not blank, this sequence will play while the response menu is being shown.

sequence

string PixelCrushers.DialogueSystem.Subtitle.sequence

The sequence associated with the line.

The Sequencer plays this sequence. See sequencer.

speakerInfo

CharacterInfo PixelCrushers.DialogueSystem.Subtitle.speakerInfo

Info about the speaker of this line.

---

The documentation for this class was generated from the following file:

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/MVC/Model/Logic/Shared/Subtitle.cs