PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker Class Reference

This component sends Dialogue System events to PlayMaker FSMs. More...

Inheritance diagram for PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker:
Collaboration diagram for PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker:

Classes

class  EventData
 

Public Member Functions

void SendEvent (string fsmEventName)
 Sends an event to the FSMs. More...
 
void OnRecordPersistentData ()
 Sent when the Dialogue System is recording persistent data into the Lua environment, usually when saving a game or before changing levels. More...
 
void OnApplyPersistentData ()
 Sent when the Dialogue System is applying persistent data to the scene from the Lua environment, usually when loading a game or after changing levels. More...
 
void OnLevelWillBeUnloaded ()
 Sent prior to unloading a level, usually before changing levels. More...
 

Public Attributes

PlayMakerFSM[] FSMs
 The FSMs that will receive Dialogue System events. More...
 
EventData eventData = new EventData()
 
bool debug = false
 

Detailed Description

This component sends Dialogue System events to PlayMaker FSMs.

Generally you will add this component to the Dialogue Manager or an actor such as the player object. See the user manual section Script Overview > Notification Messages for information about Dialogue System events.

Member Function Documentation

◆ OnApplyPersistentData()

void PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker.OnApplyPersistentData ( )

Sent when the Dialogue System is applying persistent data to the scene from the Lua environment, usually when loading a game or after changing levels.

◆ OnLevelWillBeUnloaded()

void PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker.OnLevelWillBeUnloaded ( )

Sent prior to unloading a level, usually before changing levels.

◆ OnRecordPersistentData()

void PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker.OnRecordPersistentData ( )

Sent when the Dialogue System is recording persistent data into the Lua environment, usually when saving a game or before changing levels.

◆ SendEvent()

void PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker.SendEvent ( string  fsmEventName)

Sends an event to the FSMs.

Parameters
fsmEventNameFSM event name.

Member Data Documentation

◆ debug

bool PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker.debug = false

◆ eventData

EventData PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker.eventData = new EventData()

◆ FSMs

PlayMakerFSM [] PixelCrushers.DialogueSystem.PlayMaker.DialogueSystemEventsToPlayMaker.FSMs

The FSMs that will receive Dialogue System events.


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