PixelCrushers.DialogueSystem.BarkOnIdle Class Reference

The bark on idle component can be used to make an NPC bark on timed intervals. More...

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

Public Member Functions

void StartBarkLoop ()
 Starts the bark loop. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.BarkStarter
void TryBark (Transform target)
 Barks if the condition is true. More...
 
void TryBark (Transform target, Transform interactor)
 Barks if the condition is true. More...
 
void ResetBarkHistory ()
 Resets the bark history to the beginning of the list of bark lines. More...
 
void OnRecordPersistentData ()
 Listens for the OnRecordPersistentData message and records the current bark index. More...
 
void OnApplyPersistentData ()
 Listens for the OnApplyPersistentData message and retrieves the current bark index. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.ConversationStarter
void TryStartConversation (Transform actor)
 If the condition is true, starts the conversation between the specified actor and the character that this component is attached to. More...
 
void TryStartConversation (Transform actor, Transform interactor)
 If the condition is true, starts the conversation between the specified actor and the character that this component is attached to. More...
 

Public Attributes

float minSeconds = 5f
 The minimum seconds between barks. More...
 
float maxSeconds = 10f
 The maximum seconds between barks. More...
 
Transform target
 The target to bark at. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.BarkStarter
BarkOrder barkOrder = BarkOrder.Random
 Specifies the order to run through the list of barks. More...
 
bool allowDuringConversations = false
 Are barks allowed during conversations? More...
 
bool cacheBarkLines = false
 If ticked, bark info is cached during the first bark. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.ConversationStarter
string conversation
 The title of the conversation to start. More...
 
Condition condition
 The condition required for the conversation to start. More...
 
bool skipIfNoValidEntries
 If this is true<c/c> and no valid entries currently link from the start entry, don't start the conversation. More...
 
bool exclusive = false
 Only start if no other conversation is active. More...
 
Transform conversant
 The conversant of the conversation. More...
 
bool useConversationTitlePicker = true
 
DialogueDatabase selectedDatabase = null
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
bool once = false
 Set true if this event should only happen once. More...
 

Protected Member Functions

override void OnEnable ()
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.BarkStarter
virtual void Awake ()
 
virtual void OnDisable ()
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.DialogueEventStarter
void DestroyIfOnce ()
 

Additional Inherited Members

- Properties inherited from PixelCrushers.DialogueSystem.BarkStarter
Sequencer sequencer [get]
 Gets the sequencer used by the current bark, if a bark is playing. More...
 
int BarkIndex [get, set]
 Gets or sets the bark index for sequential barks. More...
 

Detailed Description

The bark on idle component can be used to make an NPC bark on timed intervals.

Barks don't occur while a conversation is active.

Member Function Documentation

◆ OnEnable()

override void PixelCrushers.DialogueSystem.BarkOnIdle.OnEnable ( )
protectedvirtual

◆ StartBarkLoop()

void PixelCrushers.DialogueSystem.BarkOnIdle.StartBarkLoop ( )

Starts the bark loop.

Normally this is started in the Start() method. If you need to restart it for some reason, call this method.

Member Data Documentation

◆ maxSeconds

float PixelCrushers.DialogueSystem.BarkOnIdle.maxSeconds = 10f

The maximum seconds between barks.

◆ minSeconds

float PixelCrushers.DialogueSystem.BarkOnIdle.minSeconds = 5f

The minimum seconds between barks.

◆ target

Transform PixelCrushers.DialogueSystem.BarkOnIdle.target

The target to bark at.

Leave unassigned to just bark into the air.


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