PixelCrushers.DialogueSystem.ActOnDialogueEvent Class Reference

This is the abstract base class for all dialogue event handler components (e.g., SetActiveOnDialogueEvent, StartConversationOnDialogueEvent, etc). 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. More...
void	OnBarkEnd (Transform actor)
	Handles OnBarkEnd events. More...
void	OnConversationStart (Transform actor)
	Handles OnConversationStart events. More...
void	OnConversationEnd (Transform actor)
	Handles OnConversationEnd events. More...
void	OnSequenceStart (Transform actor)
	Handles OnSequenceStart events. More...
void	OnSequenceEnd (Transform actor)
	Handles OnSequenceEnd events. More...
abstract void	TryStartActions (Transform actor)
	Tries the actions that should run when the event starts (e.g., OnBarkStart). More...
abstract void	TryEndActions (Transform actor)
	Tries the actions that should run when the event ends (e.g., OnBarkEnd). More...

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

Detailed Description

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

)

Handles OnBarkEnd events.

Parameters

actor

Actor that barked.

OnBarkStart()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnBarkStart

(

Transform

actor

)

Handles OnBarkStart events.

Parameters

actor

Actor that barked.

OnConversationEnd()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnConversationEnd

(

Transform

actor

)

Handles OnConversationEnd events.

Parameters

actor

Actor that initiated the conversation.

OnConversationStart()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnConversationStart

(

Transform

actor

)

Handles OnConversationStart events.

Parameters

actor

Actor that initiated the conversation.

OnSequenceEnd()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnSequenceEnd

(

Transform

actor

)

Handles OnSequenceEnd events.

Parameters

actor

The primary actor in the sequence.

OnSequenceStart()

void PixelCrushers.DialogueSystem.ActOnDialogueEvent.OnSequenceStart

(

Transform

actor

)

Handles OnSequenceStart events.

Parameters

actor

The primary actor in the sequence.

TryEndActions()

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

pure virtual

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

Parameters

actor

Actor.

Implemented in PixelCrushers.DialogueSystem.BarkOnDialogueEvent, PixelCrushers.DialogueSystem.StartSequenceOnDialogueEvent, PixelCrushers.DialogueSystem.SetComponentEnabledOnDialogueEvent, PixelCrushers.DialogueSystem.SetEnabledOnDialogueEvent, PixelCrushers.DialogueSystem.LuaOnDialogueEvent, PixelCrushers.DialogueSystem.StartConversationOnDialogueEvent, PixelCrushers.DialogueSystem.SetQuestStateOnDialogueEvent, PixelCrushers.DialogueSystem.SetActiveOnDialogueEvent, PixelCrushers.DialogueSystem.SetAnimatorStateOnDialogueEvent, PixelCrushers.DialogueSystem.SendMessageOnDialogueEvent, and PixelCrushers.DialogueSystem.SetAnimationOnDialogueEvent.

TryStartActions()

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

pure virtual

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

Parameters

actor

Actor.

Implemented in PixelCrushers.DialogueSystem.BarkOnDialogueEvent, PixelCrushers.DialogueSystem.StartSequenceOnDialogueEvent, PixelCrushers.DialogueSystem.SetComponentEnabledOnDialogueEvent, PixelCrushers.DialogueSystem.SetEnabledOnDialogueEvent, PixelCrushers.DialogueSystem.LuaOnDialogueEvent, PixelCrushers.DialogueSystem.StartConversationOnDialogueEvent, PixelCrushers.DialogueSystem.SetQuestStateOnDialogueEvent, PixelCrushers.DialogueSystem.SetActiveOnDialogueEvent, PixelCrushers.DialogueSystem.SetAnimatorStateOnDialogueEvent, PixelCrushers.DialogueSystem.SendMessageOnDialogueEvent, and PixelCrushers.DialogueSystem.SetAnimationOnDialogueEvent.

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:

• D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Supplemental/Triggers/Handlers/ActOnDialogueEvent.cs