Implements IBarkUI for 2D Toolkit. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI:

Collaboration diagram for PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI:

Public Member Functions
void	Bark (Subtitle subtitle)
	Bark the specified subtitle. More...

void	Update ()
	Updates the seconds left and hides the label if time is up. More...

void	Hide ()
	Hides the currently-playing bark. More...

Public Attributes
tk2dTextMesh	textMesh
	The text mesh that will display barks. More...

bool	includeName
	Set `true` to include the barker's name in the text. More...

Color	defaultColor = Color.white
	The default color to use if not overridden by an emphasis tag. More...

float	duration = 4f
	The duration in seconds to show the bark. More...

float	fadeDuration = 0.5f
	The duration in seconds to fade in and out. More...

bool	waitUntilSequenceEnds
	Set `true` to keep the bark text onscreen until the sequence ends. More...

Properties
bool	IsPlaying `[get, set]`
	Gets or sets a value indicating whether this instance is playing. More...

Properties inherited from PixelCrushers.DialogueSystem.IBarkUI
bool	IsPlaying `[get]`
	Indicates or sets whether a bark is playing. More...

Detailed Description

Implements IBarkUI for 2D Toolkit.

To use barks with 2D Toolkit, add a TK2DBarkUI to the actor. Then add a tk2dTextMesh to a child object. Add the Always Fade Camera script if you want the bark to always face the main camera. Optionally add a TK2DFader if you want barks to fade in and out.

Member Function Documentation

◆ Bark()

void PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.Bark ( Subtitle subtitle )

Bark the specified subtitle.

Parameters

subtitle Subtitle to bark.

Implements PixelCrushers.DialogueSystem.IBarkUI.

◆ Hide()

void PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.Hide ( )

Hides the currently-playing bark.

Implements PixelCrushers.DialogueSystem.IBarkUI.

◆ Update()

void PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.Update ( )

Updates the seconds left and hides the label if time is up.

Member Data Documentation

◆ defaultColor

Color PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.defaultColor = Color.white

The default color to use if not overridden by an emphasis tag.

◆ duration

float PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.duration = 4f

The duration in seconds to show the bark.

◆ fadeDuration

float PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.fadeDuration = 0.5f

The duration in seconds to fade in and out.

◆ includeName

bool PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.includeName

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

◆ textMesh

tk2dTextMesh PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.textMesh

The text mesh that will display barks.

◆ waitUntilSequenceEnds

bool PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.waitUntilSequenceEnds

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

Property Documentation

◆ IsPlaying

bool PixelCrushers.DialogueSystem.TK2D.TK2DBarkUI.IsPlaying

getset

Gets or sets a value indicating whether this instance is playing.

true if this instance is playing; otherwise, false.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Integration/TK2D Integration/Assets/Dialogue System/Third Party Support/TK2D/TK2D Bark UI/TK2DBarkUI.cs

Public Member Functions

Public Attributes

Properties