PixelCrushers.DialogueSystem.BarkGroupManager Class Reference

Manages bark groups specified by BarkGroupMember. More...

Inheritance diagram for PixelCrushers.DialogueSystem.BarkGroupManager:
Collaboration diagram for PixelCrushers.DialogueSystem.BarkGroupManager:

Public Member Functions

void AddToGroup (string groupId, BarkGroupMember member)
 Registers a bark group member.
 
void RemoveFromGroup (string groupId, BarkGroupMember member)
 Unregisters a bark group member.
 
void CancelAllBarks ()
 Hides all bark members' bark UIs and clears any queued barks.
 
void MutexBark (string groupId, BarkGroupMember member)
 Hides other members' barks if they're playing.
 
void GroupBark (string conversation, BarkGroupMember member, Transform listener, BarkHistory barkHistory, float delayTime=0)
 Barks with group awareness.
 
void GroupBark (string conversation, BarkGroupMember member, Transform listener, int entryID, float delayTime=0)
 Barks with group awareness.
 
void GroupBarkString (string barkText, BarkGroupMember member, Transform listener, string sequence, float delayTime=0)
 Barks with group awareness.
 

Public Attributes

BarkGroupQueueLimitMode queueLimitMode = BarkGroupQueueLimitMode.NoLimit
 
int queueLimit = 256
 
Dictionary< string, HashSet< BarkGroupMember > > groups = new Dictionary<string, HashSet<BarkGroupMember>>()
 

Properties

static BarkGroupManager instance [get]
 

Detailed Description

Manages bark groups specified by BarkGroupMember.

Adds itself to the Dialogue Manager.

Member Function Documentation

◆ AddToGroup()

void PixelCrushers.DialogueSystem.BarkGroupManager.AddToGroup ( string  groupId,
BarkGroupMember  member 
)
inline

Registers a bark group member.

◆ CancelAllBarks()

void PixelCrushers.DialogueSystem.BarkGroupManager.CancelAllBarks ( )
inline

Hides all bark members' bark UIs and clears any queued barks.

◆ GroupBark() [1/2]

void PixelCrushers.DialogueSystem.BarkGroupManager.GroupBark ( string  conversation,
BarkGroupMember  member,
Transform  listener,
BarkHistory  barkHistory,
float  delayTime = 0 
)
inline

Barks with group awareness.

Parameters
conversationConversation to bark from.
memberBarker.
listenerBark target.
barkHistoryBark history.
delayTimeOmit/zero to use the member's random delay settings; if nonzero, use this delay time.

◆ GroupBark() [2/2]

void PixelCrushers.DialogueSystem.BarkGroupManager.GroupBark ( string  conversation,
BarkGroupMember  member,
Transform  listener,
int  entryID,
float  delayTime = 0 
)
inline

Barks with group awareness.

Parameters
conversationConversation to bark from.
memberBarker.
listenerBark target.
barkHistoryBark history.
delayTimeOmit/zero to use the member's random delay settings; if nonzero, use this delay time.

◆ GroupBarkString()

void PixelCrushers.DialogueSystem.BarkGroupManager.GroupBarkString ( string  barkText,
BarkGroupMember  member,
Transform  listener,
string  sequence,
float  delayTime = 0 
)
inline

Barks with group awareness.

Parameters
barkTextText to bark.
memberBarker.
listenerBark target.
sequenceOptional sequence to play during the bark.
delayTimeOmit/zero to use the member's random delay settings; if nonzero, use this delay time.

◆ MutexBark()

void PixelCrushers.DialogueSystem.BarkGroupManager.MutexBark ( string  groupId,
BarkGroupMember  member 
)
inline

Hides other members' barks if they're playing.

Pass null to hide all members' barks.

◆ RemoveFromGroup()

void PixelCrushers.DialogueSystem.BarkGroupManager.RemoveFromGroup ( string  groupId,
BarkGroupMember  member 
)
inline

Unregisters a bark group member.

Member Data Documentation

◆ groups

Dictionary<string, HashSet<BarkGroupMember> > PixelCrushers.DialogueSystem.BarkGroupManager.groups = new Dictionary<string, HashSet<BarkGroupMember>>()

◆ queueLimit

int PixelCrushers.DialogueSystem.BarkGroupManager.queueLimit = 256

◆ queueLimitMode

BarkGroupQueueLimitMode PixelCrushers.DialogueSystem.BarkGroupManager.queueLimitMode = BarkGroupQueueLimitMode.NoLimit

Property Documentation

◆ instance

BarkGroupManager PixelCrushers.DialogueSystem.BarkGroupManager.instance
staticget

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