Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
PixelCrushers.DialogueSystem.BarkGroupMember Class Reference

A member of a bark group. More...

Inheritance diagram for PixelCrushers.DialogueSystem.BarkGroupMember:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.BarkGroupMember:
Collaboration graph
[legend]

Public Member Functions

void GroupBark (string conversation, Transform listener, BarkHistory barkHistory, float delayTime=-1)
 
void GroupBark (string conversation, Transform listener, int entryID, float delayTime=-1)
 
void GroupBarkString (string barkText, Transform listener, string sequence, float delayTime=-1)
 
void UpdateMembership ()
 
void CancelBark ()
 

Public Attributes

string groupId
 Member of this group.
 
bool evaluateIdEveryBark = false
 Evaluate Group Id before every bark.
 
float forcedHideDelay = 0
 When another group member forces this member's bark to hide, delay this many seconds before hiding.
 
bool queueBarks = false
 If another group member is barking, wait in a queue to bark.
 
float minDelayBetweenQueuedBarks = 0
 
float maxDelayBetweenQueuedBarks = 1
 
bool hideBarkOnConversationStart = false
 

Protected Member Functions

virtual void Awake ()
 
virtual void Start ()
 

Properties

string currentIdValue [get]
 

Detailed Description

A member of a bark group.

Barks are mutually exclusive within a bark group. When one member barks, the other members hide their active barks.

Member Function Documentation

◆ Awake()

virtual void PixelCrushers.DialogueSystem.BarkGroupMember.Awake ( )
inlineprotectedvirtual

◆ CancelBark()

void PixelCrushers.DialogueSystem.BarkGroupMember.CancelBark ( )
inline

◆ GroupBark() [1/2]

void PixelCrushers.DialogueSystem.BarkGroupMember.GroupBark ( string  conversation,
Transform  listener,
BarkHistory  barkHistory,
float  delayTime = -1 
)
inline

◆ GroupBark() [2/2]

void PixelCrushers.DialogueSystem.BarkGroupMember.GroupBark ( string  conversation,
Transform  listener,
int  entryID,
float  delayTime = -1 
)
inline

◆ GroupBarkString()

void PixelCrushers.DialogueSystem.BarkGroupMember.GroupBarkString ( string  barkText,
Transform  listener,
string  sequence,
float  delayTime = -1 
)
inline

◆ Start()

virtual void PixelCrushers.DialogueSystem.BarkGroupMember.Start ( )
inlineprotectedvirtual

◆ UpdateMembership()

void PixelCrushers.DialogueSystem.BarkGroupMember.UpdateMembership ( )
inline

Member Data Documentation

◆ evaluateIdEveryBark

bool PixelCrushers.DialogueSystem.BarkGroupMember.evaluateIdEveryBark = false

Evaluate Group Id before every bark.

Useful if Id is a Lua expression that can change value.

◆ forcedHideDelay

float PixelCrushers.DialogueSystem.BarkGroupMember.forcedHideDelay = 0

When another group member forces this member's bark to hide, delay this many seconds before hiding.

◆ groupId

string PixelCrushers.DialogueSystem.BarkGroupMember.groupId

Member of this group.

Can be a Lua expression.

◆ hideBarkOnConversationStart

bool PixelCrushers.DialogueSystem.BarkGroupMember.hideBarkOnConversationStart = false

◆ maxDelayBetweenQueuedBarks

float PixelCrushers.DialogueSystem.BarkGroupMember.maxDelayBetweenQueuedBarks = 1

◆ minDelayBetweenQueuedBarks

float PixelCrushers.DialogueSystem.BarkGroupMember.minDelayBetweenQueuedBarks = 0

◆ queueBarks

bool PixelCrushers.DialogueSystem.BarkGroupMember.queueBarks = false

If another group member is barking, wait in a queue to bark.

Property Documentation

◆ currentIdValue

string PixelCrushers.DialogueSystem.BarkGroupMember.currentIdValue
get
The documentation for this class was generated from the following file: