Loading...
Searching...
No Matches
PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown Class Reference

Pauses TopDown and/or disables player input when receiving a 'Pause Player' message from the quest journal or quest dialogue UI. More...

Inheritance diagram for PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown:
Collaboration diagram for PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown:

Public Member Functions

void OnMessage (MessageArgs messageArgs)
 Handles a message that the message handler is listening for.
 
virtual void Pause ()
 
virtual void Unpause ()
 

Public Attributes

bool pauseTopDownDuringPause = true
 
bool disableTopDownInputDuringPause = true
 
string[] floatAnimatorParametersToStop = new string[] { "Speed" }
 
string[] boolAnimatorParametersToStop = new string[] { "Walking", "Running", "Jumping" }
 

Protected Member Functions

virtual void OnEnable ()
 
virtual void OnDisable ()
 

Detailed Description

Pauses TopDown and/or disables player input when receiving a 'Pause Player' message from the quest journal or quest dialogue UI.

Resumes when receiving 'Unpause Player'. You can also manually call Pause() and Unpause().

Member Function Documentation

◆ OnDisable()

virtual void PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.OnDisable ( )
inlineprotectedvirtual

◆ OnEnable()

virtual void PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.OnEnable ( )
inlineprotectedvirtual

◆ OnMessage()

void PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.OnMessage ( MessageArgs  messageArgs)
inline

Handles a message that the message handler is listening for.

Parameters
messageArgsThe message that was sent to the MessageSystem.

Implements PixelCrushers.IMessageHandler.

◆ Pause()

virtual void PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.Pause ( )
inlinevirtual

◆ Unpause()

virtual void PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.Unpause ( )
inlinevirtual

Member Data Documentation

◆ boolAnimatorParametersToStop

string [] PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.boolAnimatorParametersToStop = new string[] { "Walking", "Running", "Jumping" }

◆ disableTopDownInputDuringPause

bool PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.disableTopDownInputDuringPause = true

◆ floatAnimatorParametersToStop

string [] PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.floatAnimatorParametersToStop = new string[] { "Speed" }

◆ pauseTopDownDuringPause

bool PixelCrushers.QuestMachine.TopDownEngineSupport.PauseTopDown.pauseTopDownDuringPause = true

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