PixelCrushers.DialogueSystem.UnityUIBarkUI Class Reference

Implements IBarkUI using Unity UI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityUIBarkUI:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityUIBarkUI:

Classes
class	AnimationTransitions

Public Member Functions
void	Awake ()
void	Start ()
bool	ShouldShowText (Subtitle subtitle)
	Indicates whether the bark UI should show the text, based on the textDisplaySetting and subtitle.
override void	Bark (Subtitle subtitle)
	Barks a subtitle.
void	OnBarkEnd (Transform actor)
void	OnContinue ()
override void	Hide ()
	Hides the currently-playing bark.
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractBarkUI
void	Bark (Subtitle subtitle)
	Barks the specified subtitle.
void	Hide ()
	Hides the currently-playing bark.

Public Attributes
CanvasGroup	canvasGroup = null
	The (optional) UI canvas group.
UnityEngine.UI.Text	barkText = null
	The UI text control for the bark text.
UnityEngine.UI.Text	nameText = null
	The (optional) UI text control for the actor's name, if includeName is true.
bool	includeName = false
	Set true to include the barker's name in the text.
float	doneTime = 0
AnimationTransitions	animationTransitions = new AnimationTransitions()
float	duration = 4f
	The duration in seconds to show the bark text before fading it out.
bool	waitUntilSequenceEnds = false
	Set true to keep the bark text onscreen until the sequence ends.
bool	waitForContinueButton = false
	Wait for an "OnContinue" message.
BarkSubtitleSetting	textDisplaySetting = BarkSubtitleSetting.SameAsDialogueManager
	The text display setting.

Properties
override bool	isPlaying [get]
	Indicates whether a bark is currently playing.
Properties inherited from PixelCrushers.DialogueSystem.AbstractBarkUI
bool	isPlaying [get]
	Indicates or sets whether a bark is playing.
Properties inherited from PixelCrushers.DialogueSystem.IBarkUI

Detailed Description

Implements IBarkUI using Unity UI.

Member Function Documentation

Awake()

void PixelCrushers.DialogueSystem.UnityUIBarkUI.Awake ( )

inline

Bark()

override void PixelCrushers.DialogueSystem.UnityUIBarkUI.Bark ( Subtitle  subtitle )

inline

Barks a subtitle.

Does not observe formatting codes in the subtitle's FormattedText, instead using the formatting settings defined on this component.

Parameters

subtitle

Subtitle to bark.

Implements PixelCrushers.DialogueSystem.IBarkUI.

Hide()

override void PixelCrushers.DialogueSystem.UnityUIBarkUI.Hide ( )

inline

Hides the currently-playing bark.

Implements PixelCrushers.DialogueSystem.IBarkUI.

OnBarkEnd()

void PixelCrushers.DialogueSystem.UnityUIBarkUI.OnBarkEnd ( Transform  actor )

inline

OnContinue()

void PixelCrushers.DialogueSystem.UnityUIBarkUI.OnContinue ( )

inline

ShouldShowText()

bool PixelCrushers.DialogueSystem.UnityUIBarkUI.ShouldShowText ( Subtitle  subtitle )

inline

Indicates whether the bark UI should show the text, based on the textDisplaySetting and subtitle.

true to show text; otherwise, false.

Start()

void PixelCrushers.DialogueSystem.UnityUIBarkUI.Start ( )

inline

Member Data Documentation

animationTransitions

AnimationTransitions PixelCrushers.DialogueSystem.UnityUIBarkUI.animationTransitions = new AnimationTransitions()

barkText

UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUIBarkUI.barkText = null

The UI text control for the bark text.

canvasGroup

CanvasGroup PixelCrushers.DialogueSystem.UnityUIBarkUI.canvasGroup = null

The (optional) UI canvas group.

If assigned, the fade will occur on this control. The other controls should be children of this canvas group.

doneTime

float PixelCrushers.DialogueSystem.UnityUIBarkUI.doneTime = 0

duration

float PixelCrushers.DialogueSystem.UnityUIBarkUI.duration = 4f

The duration in seconds to show the bark text before fading it out.

includeName

bool PixelCrushers.DialogueSystem.UnityUIBarkUI.includeName = false

Set true to include the barker's name in the text.

nameText

UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUIBarkUI.nameText = null

The (optional) UI text control for the actor's name, if includeName is true.

If null, the name is added to the front of the subtitle text instead.

textDisplaySetting

BarkSubtitleSetting PixelCrushers.DialogueSystem.UnityUIBarkUI.textDisplaySetting = BarkSubtitleSetting.SameAsDialogueManager

The text display setting.

Defaults to use the same subtitle setting as the Dialogue Manager, but you can also set it to always show or always hide the text.

waitForContinueButton

bool PixelCrushers.DialogueSystem.UnityUIBarkUI.waitForContinueButton = false

Wait for an "OnContinue" message.

waitUntilSequenceEnds

bool PixelCrushers.DialogueSystem.UnityUIBarkUI.waitUntilSequenceEnds = false

Set true to keep the bark text onscreen until the sequence ends.

Property Documentation

isPlaying

override bool PixelCrushers.DialogueSystem.UnityUIBarkUI.isPlaying

get

Indicates whether a bark is currently playing.

true if playing; otherwise, false.

Implements PixelCrushers.DialogueSystem.IBarkUI.

---

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

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Unity UI/Bark/UnityUIBarkUI.cs