PixelCrushers.DialogueSystem.LuaOnDialogueEvent Class Reference

Runs Lua code at the start and/or end of a dialogue event. More...

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

Classes

class  LuaAction
 The parameters for a Lua action. More...
 

Public Member Functions

override void TryStartActions (Transform actor)
 Tries the actions that should run when the event starts (e.g., OnBarkStart). More...
 
override void TryEndActions (Transform actor)
 Tries the actions that should run when the event ends (e.g., OnBarkEnd). More...
 
void DoAction (LuaAction action, Transform actor)
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.ActOnDialogueEvent
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...
 

Public Attributes

LuaAction[] onStart = new LuaAction[0]
 Actions to take on the "start" event (e.g., OnConversationStart). More...
 
LuaAction[] onEnd = new LuaAction[0]
 Actions to take on the "end" event (e.g., OnConversationEnd). More...
 
bool debugLua
 If true, prints Lua debug information to the console. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.ActOnDialogueEvent
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

Runs Lua code at the start and/or end of a dialogue event.

Member Function Documentation

◆ DoAction()

void PixelCrushers.DialogueSystem.LuaOnDialogueEvent.DoAction ( LuaAction  action,
Transform  actor 
)

◆ TryEndActions()

override void PixelCrushers.DialogueSystem.LuaOnDialogueEvent.TryEndActions ( Transform  actor)
virtual

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

Parameters
actorActor.

Implements PixelCrushers.DialogueSystem.ActOnDialogueEvent.

◆ TryStartActions()

override void PixelCrushers.DialogueSystem.LuaOnDialogueEvent.TryStartActions ( Transform  actor)
virtual

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

Parameters
actorActor.

Implements PixelCrushers.DialogueSystem.ActOnDialogueEvent.

Member Data Documentation

◆ debugLua

bool PixelCrushers.DialogueSystem.LuaOnDialogueEvent.debugLua

If true, prints Lua debug information to the console.

◆ onEnd

LuaAction [] PixelCrushers.DialogueSystem.LuaOnDialogueEvent.onEnd = new LuaAction[0]

Actions to take on the "end" event (e.g., OnConversationEnd).

◆ onStart

LuaAction [] PixelCrushers.DialogueSystem.LuaOnDialogueEvent.onStart = new LuaAction[0]

Actions to take on the "start" event (e.g., OnConversationStart).


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