PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener Class Reference

Adds option to integrate Dialogue System saving with Corgi SaveLoadManager. More...

Inheritance diagram for PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener:
Collaboration diagram for PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener:

Public Member Functions

virtual void OnMMEvent (CorgiEngineEvent engineEvent)
 
void PauseCorgi (bool allowAutoFocus)
 Pause Corgi Engine, for example to show a quest log window.
 
void UnpauseCorgi ()
 Unpause Corgi Engine, for example when closing the quest log window.
 
virtual void OnMMEvent (MMGameEvent gameEvent)
 
void SaveDialogueSystem ()
 Saves the Dialogue System's state to Corgi's MMSaveLoadManager.
 
void LoadDialogueSystem ()
 Loads the Dialogue System's state from data previously saved in Corgi's MMSaveLoadManager.
 

Public Attributes

bool handleMMSaveLoadEvents = false
 

Protected Member Functions

virtual void OnEnable ()
 On enable, we start listening for MMGameEvents.
 
virtual void OnDisable ()
 On disable, we stop listening for MMGameEvents.
 
IEnumerator Unpause (bool reenableCorgiComponents)
 
virtual void SetCorgiComponents (bool value)
 

Protected Attributes

bool _prevSendNavEvents
 
CameraController _cameraController = null
 
MoreMountains.InventoryEngine.InventoryInputManager _inventoryInputManager = null
 

Static Protected Attributes

const string _saveFolderName = "DialogueSystem/"
 
const string _saveFileExtension = ".data"
 

Properties

CameraController cameraController [get]
 
MoreMountains.InventoryEngine.InventoryInputManager inventoryInputManager [get]
 

Detailed Description

Adds option to integrate Dialogue System saving with Corgi SaveLoadManager.

Also provides methods to pause and unpause Corgi.

Member Function Documentation

◆ LoadDialogueSystem()

void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.LoadDialogueSystem ( )
inline

Loads the Dialogue System's state from data previously saved in Corgi's MMSaveLoadManager.

◆ OnDisable()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.OnDisable ( )
inlineprotectedvirtual

On disable, we stop listening for MMGameEvents.

◆ OnEnable()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.OnEnable ( )
inlineprotectedvirtual

On enable, we start listening for MMGameEvents.

◆ OnMMEvent() [1/2]

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.OnMMEvent ( CorgiEngineEvent  engineEvent)
inlinevirtual

◆ OnMMEvent() [2/2]

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.OnMMEvent ( MMGameEvent  gameEvent)
inlinevirtual

◆ PauseCorgi()

void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.PauseCorgi ( bool  allowAutoFocus)
inline

Pause Corgi Engine, for example to show a quest log window.

Parameters
allowAutoFocus

◆ SaveDialogueSystem()

void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.SaveDialogueSystem ( )
inline

Saves the Dialogue System's state to Corgi's MMSaveLoadManager.

◆ SetCorgiComponents()

virtual void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.SetCorgiComponents ( bool  value)
inlineprotectedvirtual

◆ Unpause()

IEnumerator PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.Unpause ( bool  reenableCorgiComponents)
inlineprotected

◆ UnpauseCorgi()

void PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.UnpauseCorgi ( )
inline

Unpause Corgi Engine, for example when closing the quest log window.

Member Data Documentation

◆ _cameraController

CameraController PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener._cameraController = null
protected

◆ _inventoryInputManager

MoreMountains.InventoryEngine.InventoryInputManager PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener._inventoryInputManager = null
protected

◆ _prevSendNavEvents

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener._prevSendNavEvents
protected

◆ _saveFileExtension

const string PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener._saveFileExtension = ".data"
staticprotected

◆ _saveFolderName

const string PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener._saveFolderName = "DialogueSystem/"
staticprotected

◆ handleMMSaveLoadEvents

bool PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.handleMMSaveLoadEvents = false

Property Documentation

◆ cameraController

CameraController PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.cameraController
getprotected

◆ inventoryInputManager

MoreMountains.InventoryEngine.InventoryInputManager PixelCrushers.DialogueSystem.CorgiEngineSupport.DialogueSystemCorgiEventListener.inventoryInputManager
getprotected

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