A conversation display which can be used on characters in 2D or 3D world space. The display can be set to automatically rotate to face a camera or other object. More...

Inherits EasyTalk.Display.ConversationDisplay.

Properties
bool	PointAtTransform `[get, set]`
	Gets or sets whether the conversation display should automatically look at a transform location.

Transform	LookAt `[get, set]`
	Gets or sets the transform that the conversation display should point toward whenever pointAtTransform is set to true.

Properties inherited from EasyTalk.Display.ConversationDisplay
Text	StandardCharacterNameText `[get, set]`
	Gets or sets the standard Unity Text component of the display for the character name.

Image	CharacterNameBackgroundImage `[get]`
	Gets the image used for the character name panel.

Text	StandardConvoText `[get, set]`
	Gets or sets the standard Unity Text component of the display.

List< Image >	ConversationPanelImages `[get]`
	Gets the List of images used for the conversation display panel.

TextDisplayMode	TextPresentationMode `[get, set]`
	Gets or sets the display mode used for dialogue text.

float	WordsPerSecond `[get, set]`
	Gets or sets the number of words per second to display when displaying dialogue in BY_WORD mode.

float	CharactersPerSecond `[get, set]`
	Gets or sets the number of characters per second to display when displaying dialogue in BY_CHARACTER mode.

Properties inherited from EasyTalk.Display.DialoguePanel
string	DisplayID `[get, set]`
	Gets or sets the Display ID of the panel.

bool	IsHidden `[get]`
	Gets whether the panel is currently hidden.

Vector3	OriginalPosition `[get]`
	Gets the original position of the panel.

UIAnimator.Animation	AnimationType `[get, set]`
	Gets or sets the animation type used for showing and hiding the panel.

bool	OverrideFontSizes `[get, set]`
	Gets or sets whether the component should override the default font sizes.

LanguageFontOverrides	LanguageFontOverrides `[get, set]`
	Gets or sets the LanguageFontOverrides to use on the component.

int	MinFontSize `[get, set]`
	Gets or sets the minimum font size to use on the component.

int	MaxFontSize `[get, set]`
	Gets or sets the maximum font size to use on the component.

Properties inherited from EasyTalk.Display.LocalizableComponent

Private Member Functions
void	Update ()
	Update the rotation of the display to point at the lookAt transform if pointAtTransform is set to true.

Private Attributes
bool	pointAtTransform
	Whether the display should automatically point at a transform location.

Transform	lookAt
	The transform which the conversation display should point toward whenever pointAtTransform is set to true.

Additional Inherited Members
Public Types inherited from EasyTalk.Display.ConversationDisplay
enum	TextDisplayMode { FULL , BY_WORD , BY_CHARACTER }
	Defines possible modes for displaying dialogue text. More...

Public Member Functions inherited from EasyTalk.Display.ConversationDisplay
void	ShowConversationText ()
	Activates the conversation text.

virtual void	HideConversationText ()
	Deactivates the conversation text.

void	ShowCharacterName ()
	Activates the character name text.

virtual void	HideCharacterName ()
	Deactivates the character name text.

void	SetConversationText (string text)
	Sets the value of the conversation display dialogue text element.

void	AppendText (string text)

IEnumerator	SetConversationText (ConversationLine line)
	Asynchronously sets the conversation display's dialogue text based on the text display mode to the text of the line of dialogue provided.

IEnumerator	SetConversationTextAsync (string text, float delay=0.0f)
	Asynchronously sets the displayed dialogue text based on the text display mode set on this conversation display. The delay is used to sync the timing of the text with the total time alloted to the line of dialogue (applies when the dialogue controller is in AUTOPLAY mode).

void	SetCharacterName (string characterName, string sourceName)
	Sets the character name text to display the provided character name.

void	Reset ()
	Resets the conversation display by setting the character name and conversation text to blank values.

virtual void	TranslateText (DialogueController controller)
	Translates the conversation text and character name based on the current language set on EasyTalkGameState.Instance.Language.

Public Member Functions inherited from EasyTalk.Display.DialoguePanel
virtual void	Init ()
	Initializes the panel by storing the original position.

void	Activate ()
	Sets the panel to be active, and recursively sets all parent game objects to be active.

void	Deactivate ()
	Makes the panel inactive.

bool	ForceStandardText ()

IEnumerator	WaitForAnimation ()
	Asynchronously waits for the currently running animation on this panel to complete.

virtual void	Hide (bool deactivateAfterHide=true)
	Hides the panel.

void	HideImmediately (bool deactivateAfterHide=true)
	Hides the panel immediately (doesn't use a transition animation).

void	ShowImmediately ()
	Shows the panel immediately (doesn't use a transition animation).

virtual void	Show ()
	Shows the panel.

Public Member Functions inherited from EasyTalk.Controller.DialogueListener
virtual void	OnContinue ()
	Called whenever the dialogue continues on to the next line.

virtual void	OnDisplayOptions (List< DialogueOption > options)
	Called whenever dialogue options are to be presented.

virtual void	OnOptionChosen (DialogueOption option)
	Called whenever an option is chosen from the currently presented list of options.

virtual void	OnDisplayLine (ConversationLine conversationLine)
	Called when a line of dialogue is to be presented.

virtual void	OnDialogueEntered (string entryPointName)
	Called whenever a dialogue is entered (when playback begins).

virtual void	OnDialogueExited (string exitPointName)
	Called whenever a dialogue is exited (when playback ends).

virtual void	OnExitCompleted ()
	Called at least one frame after a dialogue is exited.

virtual void	OnStory (string storyText)
	Called whenever a story node is encountered.

virtual void	OnVariableUpdated (string variableName, object value)
	Called whenever a dialogue variable value is updated.

virtual void	OnCharacterChanged (string oldCharacterName, string newCharacterName)
	Called whenever a character change is detected.

virtual void	OnAudioStarted (ConversationLine line)
	Called whenever audio starts playing for a line of dialogue.

virtual void	OnAudioCompleted (ConversationLine line, bool forceStopped)
	Called whenever audio stops playing for a line of dialogue.

virtual void	OnActivateKey (string key)
	Called whenever a key tag is present in a line of dialogue.

virtual void	Wait (float timeInSeconds)
	Called whenever the dialogue encounters a wait node.

virtual void	OnConversationEnding (ConversationLine line, Node nextNode)
	Called whenever the last line of dialogue in a conversation node is reached.

virtual void	OnNodeChanged (Node node)
	Called whenever dialogue playback moves to the next node.

virtual void	OnPause (string signal)
	Called whenever a pause node is reached during dialogue playback.

virtual void	OnExecuteAsyncNode (AsyncNode node)

virtual void	OnWaitingForNodeEvaluation (Node asyncNode)

virtual void	OnNodeEvaluationCompleted (Node asyncNode)

Public Attributes inherited from EasyTalk.Display.DialoguePanel
UnityEvent	onHideStart = new UnityEvent()
	An event which is triggered whenever the panel starts being hidden.

UnityEvent	onHideComplete = new UnityEvent()
	An event which is triggered whenever the panel has finished transitioning to a hidden state.

UnityEvent	onShowStart = new UnityEvent()
	An event which is triggered whenever the panel starts being shown.

UnityEvent	onShowComplete = new UnityEvent()
	An event which is triggered whenever the panel has finished transitioning to a shown state.

Public Attributes inherited from EasyTalk.Controller.DialogueListener
bool	debugEnabled = false
	When set to true, debug logging will be shown for each method called on the listener.

UnityEvent	onContinue = new UnityEvent()
	An event which is triggered whenever the dialogue continues.

UnityEvent	onDisplayOptions = new UnityEvent()
	An event which is triggered whenever options are to be displayed to the player.

UnityEvent	onOptionChosen = new UnityEvent()
	An event which is triggered whenever the player chooses an option.

UnityEvent	onDisplayLine = new UnityEvent()
	An event which is triggered whenever a line of dialogue is to be displayed.

UnityEvent	onDialogueEntered = new UnityEvent()
	An event which is triggered whenever dialogue playback begins.

UnityEvent	onDialogueExited = new UnityEvent()
	An event which is triggered whenever dialogue playback ends.

UnityEvent	onExitCompleted = new UnityEvent()
	An event which is triggered one frame after dialogue playback ends.

UnityEvent	onStory = new UnityEvent()
	An event which is triggered whenever a story node is encountered.

UnityEvent	onVariableUpdated = new UnityEvent()
	An event which is triggered whenever a dialogue variable value is updated.

UnityEvent	onCharacterChanged = new UnityEvent()
	An event which is triggered whenever a character name change is detected.

UnityEvent	onAudioStarted = new UnityEvent()
	An event which is triggered whenever dialogue audio starts playing.

UnityEvent	onAudioCompleted = new UnityEvent()
	An event which is triggered whenever dialogue audio finishes playing.

UnityEvent	onActivateKey = new UnityEvent()
	An event which is triggered whenever a key is to be processed on a dialogue.

UnityEvent	onWait = new UnityEvent()
	An event which is triggered whenever a dialogue starts waiting for a certain period of time before continuing.

UnityEvent	onConversationEnding = new UnityEvent()
	An event which is triggered whenever the last line of dialogue in a conversation node is reached.

UnityEvent	onNodeChanged = new UnityEvent()
	An event which is triggered whenever a the dialogue flows from one node to another.

UnityEvent	onPause = new UnityEvent()
	An event which is triggered whenever the dialogue reaches a pause node, pausing and waiting for Continue() to be called.

UnityEvent	onExecuteAsyncNode = new UnityEvent()

UnityEvent	onWaitingForNodeCompletion = new UnityEvent()

UnityEvent	onNodeEvaluationCompleted = new UnityEvent()

Protected Member Functions inherited from EasyTalk.Display.DialoguePanel
IEnumerator	SlideDisplayOut (bool deactivateAfterSlide=true)
	Asynchronously slides the display out of its Canvas' bounds.

IEnumerator	SlideDisplayIn ()
	Asynchronously slides the display into its Canvas' bounds. If returnToOriginalPosition is set to true, then the panel will slide to its original position.

IEnumerator	FadeDisplayIn ()
	Asynchronously fades the display and all of its child text and image components in to their original transparency values.

IEnumerator	FadeDisplayOut (bool deactivateAfterFade=true)
	Asynchronously fades the display and all of its child text and image components out to be completely transparent.

Protected Attributes inherited from EasyTalk.Display.ConversationDisplay
UnityEvent	onCharacterNameUpdated = new UnityEvent()
	An event which is triggered when the character name is updated.

UnityEvent	onConversationTextUpdated = new UnityEvent()
	An event which is triggered when the covnersation text is updated.

UnityEvent	onReset = new UnityEvent()
	An event which is triggered whenever the display is cleared out, meaning the conversation text and character name are set to empty strings.

ConversationLine	currentLine
	The current line of dialogue being displayed by the conversation display.

Protected Attributes inherited from EasyTalk.Display.DialoguePanel
bool	forceStandardText = false
	Whether the Display uses standard Text components rather than TextMeshPro components, even with TextMeshPro installed.

Vector3	originalPosition = Vector3.zero
	The original position of the panel.

bool	isHidden = false
	Whether the panel is currently hidden.

Detailed Description

A conversation display which can be used on characters in 2D or 3D world space. The display can be set to automatically rotate to face a camera or other object.

Member Function Documentation

◆ Update()

void EasyTalk.Display.WorldspaceConversationDisplay.Update ( )

private

Update the rotation of the display to point at the lookAt transform if pointAtTransform is set to true.

Member Data Documentation

◆ lookAt

Transform EasyTalk.Display.WorldspaceConversationDisplay.lookAt

private

The transform which the conversation display should point toward whenever pointAtTransform is set to true.

◆ pointAtTransform

bool EasyTalk.Display.WorldspaceConversationDisplay.pointAtTransform

private

Whether the display should automatically point at a transform location.

Property Documentation

◆ LookAt

Transform EasyTalk.Display.WorldspaceConversationDisplay.LookAt

getset

Gets or sets the transform that the conversation display should point toward whenever pointAtTransform is set to true.

◆ PointAtTransform

bool EasyTalk.Display.WorldspaceConversationDisplay.PointAtTransform

getset

Gets or sets whether the conversation display should automatically look at a transform location.

Properties

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Update()

Member Data Documentation

◆ lookAt

◆ pointAtTransform

Property Documentation

◆ LookAt

◆ PointAtTransform