An animatable sprite panel which supports setting the animated image based on a character configured in the Character Library. More...

Inherits EasyTalk.Display.AnimatableSpritePanel.

Public Member Functions
override void	Init ()
	Initializes the panel by storing the original position.

bool	SetImageOnPanel (string characterName, string imageId=null)
	Given a character name, an animatable image will be retrieved from the character library for that character and displayed on the panel. If the panel is set to ICON mode, the image will be pulled from the configured icons of the character. If the panel is in PORTRAYAL mode, then the image will be pulled from portrayals instead. An image ID can also be specified to use a specific image configured for the character. IF no image ID is specified, the first image in their list of icons/portrayals will be used.

Public Member Functions inherited from EasyTalk.Display.AnimatableSpritePanel
void	SetImageOnPanel (AnimatableDisplayImage animImage)
	Sets the AnimatableDisplayImage to display on the panel.

Public Member Functions inherited from EasyTalk.Display.DialoguePanel
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 ()
	Returns whether or not the panel should force standard text component usage, even when TextMesh Pro is available.

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)
	Called whenever an async node is encountered and needs some external class to handle its execution.

virtual void	OnWaitingForNodeEvaluation (Node asyncNode)
	Called just before an asynchronous node is executed to notify listeners that the dialogue is about to enter a waiting state.

virtual void	OnNodeEvaluationCompleted (Node asyncNode)
	Called whenever an asynchronous node's evaluation/execution has been commpleted.

Properties
CharacterLibrary	CharacterLibrary `[get]`
	Gets the Character Library.

string	CurrentCharacterName `[get]`
	Gets the name of the character currently being displayed.

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 panel should override the default language-specific minimum and maximum font sizes when the language is updated.

LanguageFontOverrides	LanguageFontOverrides `[get, set]`
	Gets or sets the LanguageFontOverrides which are used to change fonts when the language is changed.

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

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

Properties inherited from EasyTalk.Display.LocalizableComponent

Private Member Functions
void	Awake ()

void	InitializeCharacterLibrary ()
	Sets the character library from the Dialogue Registry.

Private Attributes
CharacterSpriteMode	spriteMode = CharacterSpriteMode.PORTRAYAL
	The image mode to use. In PORTRAYAL mode, the chosen sprite(s) will be retrieved from a character's configured portrayals. In ICON mode, the sprite(s) come from the character's configured icons.

bool	showWhenInvalid = true
	Whether or not the panel's image should be updated when a null or empty image ID is used.

CharacterLibrary	characterLibrary
	The character library being used.

string	currentCharacterName = null
	The name of the character currently being shown on the panel.

Additional Inherited Members
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()
	An event which is triggered whenever an asynchronous node must be processed.

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.

virtual void	OnShowStart ()
	Callback for when the panel begines to be shown.

virtual void	OnShowComplete ()
	Callback for when the panel is finished being shown (when all animations are complete).

virtual void	OnHideStart ()
	Callback for when the panel begins to be hidden.

virtual void	OnHideComplete ()
	Callback for when the panel has finished being hidden (when all animations are complete).

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

An animatable sprite panel which supports setting the animated image based on a character configured in the Character Library.

Member Function Documentation

◆ Awake()

void EasyTalk.Display.CharacterSpritePanel.Awake ( )

private

◆ Init()

override void EasyTalk.Display.CharacterSpritePanel.Init ( )

virtual

Initializes the panel by storing the original position.

Reimplemented from EasyTalk.Display.AnimatableSpritePanel.

◆ InitializeCharacterLibrary()

void EasyTalk.Display.CharacterSpritePanel.InitializeCharacterLibrary ( )

private

Sets the character library from the Dialogue Registry.

◆ SetImageOnPanel()

bool EasyTalk.Display.CharacterSpritePanel.SetImageOnPanel	(	string	characterName,
		string	imageId = null )

Given a character name, an animatable image will be retrieved from the character library for that character and displayed on the panel. If the panel is set to ICON mode, the image will be pulled from the configured icons of the character. If the panel is in PORTRAYAL mode, then the image will be pulled from portrayals instead. An image ID can also be specified to use a specific image configured for the character. IF no image ID is specified, the first image in their list of icons/portrayals will be used.

Parameters

characterName	The name of the character to display.
imageId	An optional image ID for the image to retrieve from the character library.

Returns: Returns true if an image was found and set successfully; otherwise false.

Member Data Documentation

◆ characterLibrary

CharacterLibrary EasyTalk.Display.CharacterSpritePanel.characterLibrary

private

The character library being used.

◆ currentCharacterName

string EasyTalk.Display.CharacterSpritePanel.currentCharacterName = null

private

The name of the character currently being shown on the panel.

◆ showWhenInvalid

bool EasyTalk.Display.CharacterSpritePanel.showWhenInvalid = true

private

Whether or not the panel's image should be updated when a null or empty image ID is used.

◆ spriteMode

CharacterSpriteMode EasyTalk.Display.CharacterSpritePanel.spriteMode = CharacterSpriteMode.PORTRAYAL

private

The image mode to use. In PORTRAYAL mode, the chosen sprite(s) will be retrieved from a character's configured portrayals. In ICON mode, the sprite(s) come from the character's configured icons.

Property Documentation

◆ CharacterLibrary

CharacterLibrary EasyTalk.Display.CharacterSpritePanel.CharacterLibrary

get

Gets the Character Library.

◆ CurrentCharacterName

string EasyTalk.Display.CharacterSpritePanel.CurrentCharacterName

get

Gets the name of the character currently being displayed.

Public Member Functions

Properties

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Awake()

◆ Init()

◆ InitializeCharacterLibrary()

◆ SetImageOnPanel()

Member Data Documentation

◆ characterLibrary

◆ currentCharacterName

◆ showWhenInvalid

◆ spriteMode

Property Documentation

◆ CharacterLibrary

◆ CurrentCharacterName