PixelCrushers.DialogueSystem.ActOnDialogueEvent Class Referenceabstract

Deprecated by DialogueSystemTrigger. More...

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

Classes

class  Action
 The base class for actions that will run at the start or end of dialogue events. More...
 

Public Member Functions

void OnBarkStart (Transform actor)
 Handles OnBarkStart events.
 
void OnBarkEnd (Transform actor)
 Handles OnBarkEnd events.
 
void OnConversationStart (Transform actor)
 Handles OnConversationStart events.
 
void OnConversationEnd (Transform actor)
 Handles OnConversationEnd events.
 
void OnSequenceStart (Transform actor)
 Handles OnSequenceStart events.
 
void OnSequenceEnd (Transform actor)
 Handles OnSequenceEnd events.
 
void TryStartActions (Transform actor)
 Tries the actions that should run when the event starts (e.g., OnBarkStart).
 
void TryEndActions (Transform actor)
 Tries the actions that should run when the event ends (e.g., OnBarkEnd).
 

Public Attributes

DialogueEvent trigger
 The dialogue event that triggers the actions.
 
bool once = false
 Set true if this should only happen once.
 
DialogueDatabase selectedDatabase = null
 

Detailed Description

Deprecated by DialogueSystemTrigger.

This is the abstract base class for all dialogue event handler components (e.g., SetActiveOnDialogueEvent, StartConversationOnDialogueEvent, etc). Dialogue events occur when a bark, conversation, or sequence starts and ends. Subclasses implement TryStartActions() and TryEndActions().

Member Function Documentation

◆ OnBarkEnd()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnBarkEnd ( Transform  actor)
inline

Handles OnBarkEnd events.

Parameters
actorActor that barked.

◆ OnBarkStart()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnBarkStart ( Transform  actor)
inline

Handles OnBarkStart events.

Parameters
actorActor that barked.

◆ OnConversationEnd()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnConversationEnd ( Transform  actor)
inline

Handles OnConversationEnd events.

Parameters
actorActor that initiated the conversation.

◆ OnConversationStart()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnConversationStart ( Transform  actor)
inline

Handles OnConversationStart events.

Parameters
actorActor that initiated the conversation.

◆ OnSequenceEnd()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnSequenceEnd ( Transform  actor)
inline

Handles OnSequenceEnd events.

Parameters
actorThe primary actor in the sequence.

◆ OnSequenceStart()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnSequenceStart ( Transform  actor)
inline

Handles OnSequenceStart events.

Parameters
actorThe primary actor in the sequence.

◆ TryEndActions()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.TryEndActions ( Transform  actor)
abstract

Tries the actions that should run when the event ends (e.g., OnBarkEnd).

Parameters
actorActor.

◆ TryStartActions()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.TryStartActions ( Transform  actor)
abstract

Tries the actions that should run when the event starts (e.g., OnBarkStart).

Parameters
actorActor.

Member Data Documentation

◆ once

bool PixelCrushers.DialogueSystem.ActOnDialogueEvent.once = false

Set true if this should only happen once.

◆ selectedDatabase

DialogueDatabase PixelCrushers.DialogueSystem.ActOnDialogueEvent.selectedDatabase = null

◆ trigger

DialogueEvent PixelCrushers.DialogueSystem.ActOnDialogueEvent.trigger

The dialogue event that triggers the actions.


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