PixelCrushers.DialogueSystem.BarkTrigger Class Reference

The bark trigger component can be used to make an NPC bark when it receives a dialogue trigger – for example, when the game starts or when the level loads. More...

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

Public Member Functions

void OnBarkEnd (Transform actor)
 
void OnConversationEnd (Transform actor)
 
void OnSequenceEnd (Transform actor)
 
void OnUse (Transform actor)
 
void OnUse (string message)
 
void OnUse ()
 
void OnTriggerEnter (Collider other)
 
void OnTriggerEnter2D (Collider2D other)
 
void OnTriggerExit (Collider other)
 
void OnTriggerExit2D (Collider2D other)
 
void OnCollisionEnter (Collision collision)
 
void OnCollisionEnter2D (Collision2D collision)
 
void OnCollisionExit (Collision collision)
 
void OnCollisionExit2D (Collision2D collision)
 
void Start ()
 
void OnLevelWillBeUnloaded ()
 
void OnApplicationQuit ()
 
void OnDestroy ()
 
- 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

Transform target
 The target that the bark is directed to. More...
 
DialogueTriggerEvent trigger = DialogueTriggerEvent.OnUse
 The trigger that starts the conversation. 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 ()
 
override void OnDisable ()
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.BarkStarter
virtual void Awake ()
 
- 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 trigger component can be used to make an NPC bark when it receives a dialogue trigger – for example, when the game starts or when the level loads.

You can specify an optional target to bark at.

Member Function Documentation

◆ OnApplicationQuit()

void PixelCrushers.DialogueSystem.BarkTrigger.OnApplicationQuit ( )

◆ OnBarkEnd()

void PixelCrushers.DialogueSystem.BarkTrigger.OnBarkEnd ( Transform  actor)

◆ OnCollisionEnter()

void PixelCrushers.DialogueSystem.BarkTrigger.OnCollisionEnter ( Collision  collision)

◆ OnCollisionEnter2D()

void PixelCrushers.DialogueSystem.BarkTrigger.OnCollisionEnter2D ( Collision2D  collision)

◆ OnCollisionExit()

void PixelCrushers.DialogueSystem.BarkTrigger.OnCollisionExit ( Collision  collision)

◆ OnCollisionExit2D()

void PixelCrushers.DialogueSystem.BarkTrigger.OnCollisionExit2D ( Collision2D  collision)

◆ OnConversationEnd()

void PixelCrushers.DialogueSystem.BarkTrigger.OnConversationEnd ( Transform  actor)

◆ OnDestroy()

void PixelCrushers.DialogueSystem.BarkTrigger.OnDestroy ( )

◆ OnDisable()

override void PixelCrushers.DialogueSystem.BarkTrigger.OnDisable ( )
protectedvirtual

◆ OnEnable()

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

◆ OnLevelWillBeUnloaded()

void PixelCrushers.DialogueSystem.BarkTrigger.OnLevelWillBeUnloaded ( )

◆ OnSequenceEnd()

void PixelCrushers.DialogueSystem.BarkTrigger.OnSequenceEnd ( Transform  actor)

◆ OnTriggerEnter()

void PixelCrushers.DialogueSystem.BarkTrigger.OnTriggerEnter ( Collider  other)

◆ OnTriggerEnter2D()

void PixelCrushers.DialogueSystem.BarkTrigger.OnTriggerEnter2D ( Collider2D  other)

◆ OnTriggerExit()

void PixelCrushers.DialogueSystem.BarkTrigger.OnTriggerExit ( Collider  other)

◆ OnTriggerExit2D()

void PixelCrushers.DialogueSystem.BarkTrigger.OnTriggerExit2D ( Collider2D  other)

◆ OnUse() [1/3]

void PixelCrushers.DialogueSystem.BarkTrigger.OnUse ( )

◆ OnUse() [2/3]

void PixelCrushers.DialogueSystem.BarkTrigger.OnUse ( string  message)

◆ OnUse() [3/3]

void PixelCrushers.DialogueSystem.BarkTrigger.OnUse ( Transform  actor)

◆ Start()

void PixelCrushers.DialogueSystem.BarkTrigger.Start ( )

Member Data Documentation

◆ target

Transform PixelCrushers.DialogueSystem.BarkTrigger.target

The target that the bark is directed to.

If assigned, the target will get an OnBarkEnd event.

◆ trigger

DialogueTriggerEvent PixelCrushers.DialogueSystem.BarkTrigger.trigger = DialogueTriggerEvent.OnUse

The trigger that starts the conversation.


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