PixelCrushers.DialogueSystem.BarkController Class Reference

BarkController is a static utility class provides a method to make characters bark. More...

Static Public Member Functions

static IEnumerator Bark (string conversationTitle, Transform speaker, Transform listener, BarkHistory barkHistory, DialogueDatabase database=null, bool stopAtFirstValid=false)
 Attempts to make a character bark. More...
 
static IEnumerator Bark (Subtitle subtitle, Transform speaker, Transform listener, IBarkUI barkUI)
 Attempts to make a character bark. More...
 
static IEnumerator Bark (Subtitle subtitle, bool skipSequence=false)
 Attempts to make a character bark. More...
 

Properties

static Sequencer LastSequencer [get]
 Gets the last sequencer created by BarkController.Bark(). More...
 

Detailed Description

BarkController is a static utility class provides a method to make characters bark.

Member Function Documentation

◆ Bark() [1/3]

static IEnumerator PixelCrushers.DialogueSystem.BarkController.Bark ( string  conversationTitle,
Transform  speaker,
Transform  listener,
BarkHistory  barkHistory,
DialogueDatabase  database = null,
bool  stopAtFirstValid = false 
)
static

Attempts to make a character bark.

This is a coroutine; you must start it using StartCoroutine() or Unity will hang. Shows a line from the named conversation, plays the sequence, and sends OnBarkStart/OnBarkEnd messages to the participants.

Parameters
conversationTitleTitle of conversation to pull bark lines from.
speakerSpeaker performing the bark.
listenerListener that the bark is directed to; may be null.
barkHistoryBark history used to keep track of the most recent bark so this method can iterate through them in a specified order.
databaseThe dialogue database to use. If null, uses DialogueManager.MasterDatabase.

◆ Bark() [2/3]

static IEnumerator PixelCrushers.DialogueSystem.BarkController.Bark ( Subtitle  subtitle,
bool  skipSequence = false 
)
static

Attempts to make a character bark.

This is a coroutine; you must start it using StartCoroutine() or Unity will hang. Shows a specific subtitle and plays the sequence, but does not send OnBarkStart/OnBarkEnd messages to the participants.

Parameters
subtitleSubtitle to bark.
skipSequenceIf true, don't play the sequence associated with the subtitle.

◆ Bark() [3/3]

static IEnumerator PixelCrushers.DialogueSystem.BarkController.Bark ( Subtitle  subtitle,
Transform  speaker,
Transform  listener,
IBarkUI  barkUI 
)
static

Attempts to make a character bark.

This is a coroutine; you must start it using StartCoroutine() or Unity will hang. Shows a specific subtitle and plays the sequence, but does not send OnBarkStart/OnBarkEnd messages to the participants. This optimized version

Parameters
subtitleSubtitle to bark.
speakerSpeaker performing the bark.
listenerListener that the bark is directed to; may be null.
barkUIThe bark UI to bark with.

Property Documentation

◆ LastSequencer

Sequencer PixelCrushers.DialogueSystem.BarkController.LastSequencer
staticget

Gets the last sequencer created by BarkController.Bark().

The last sequencer.


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