PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi Class Reference

Pauses Corgi 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.CorgiEngineSupport.QuestMachinePauseCorgi:

Collaboration diagram for PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi:

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	pauseCorgiDuringPause = true
bool	disableCorgiInputDuringPause = true
string[]	floatAnimatorParametersToStop = new string[] { "Speed" }
string[]	boolAnimatorParametersToStop = new string[] { }

Protected Member Functions
virtual void	OnEnable ()
virtual void	OnDisable ()
virtual IEnumerator	UnpauseAtEndOfFrame ()
virtual void	UnpauseNow ()
virtual void	SetCorgiInput (bool value)
virtual void	SetAllInputManagers (bool value)
virtual void	SetAllPlayersComponents (bool value)
virtual void	PermitAbility< T > (Character player, bool value)
IEnumerator	StopAnimators ()

Protected Attributes
int	pauseDepth = 0
bool	prevSendNavEvents = false

Detailed Description

Pauses Corgi 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.CorgiEngineSupport.QuestMachinePauseCorgi.OnDisable ( )

inlineprotectedvirtual

OnEnable()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.OnEnable ( )

inlineprotectedvirtual

OnMessage()

void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.OnMessage ( MessageArgs  messageArgs )

inline

Handles a message that the message handler is listening for.

Parameters

messageArgs

The message that was sent to the MessageSystem.

Implements PixelCrushers.IMessageHandler.

Pause()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.Pause ( )

inlinevirtual

PermitAbility< T >()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.PermitAbility< T > ( Character  player, bool  value  )

inlineprotectedvirtual

Type Constraints

T

:

CharacterAbility

SetAllInputManagers()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.SetAllInputManagers ( bool  value )

inlineprotectedvirtual

SetAllPlayersComponents()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.SetAllPlayersComponents ( bool  value )

inlineprotectedvirtual

SetCorgiInput()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.SetCorgiInput ( bool  value )

inlineprotectedvirtual

StopAnimators()

IEnumerator PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.StopAnimators ( )

inlineprotected

Unpause()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.Unpause ( )

inlinevirtual

UnpauseAtEndOfFrame()

virtual IEnumerator PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.UnpauseAtEndOfFrame ( )

inlineprotectedvirtual

UnpauseNow()

virtual void PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.UnpauseNow ( )

inlineprotectedvirtual

Member Data Documentation

boolAnimatorParametersToStop

string [] PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.boolAnimatorParametersToStop = new string[] { }

disableCorgiInputDuringPause

bool PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.disableCorgiInputDuringPause = true

floatAnimatorParametersToStop

string [] PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.floatAnimatorParametersToStop = new string[] { "Speed" }

pauseCorgiDuringPause

bool PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.pauseCorgiDuringPause = true

pauseDepth

int PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.pauseDepth = 0

protected

prevSendNavEvents

bool PixelCrushers.QuestMachine.CorgiEngineSupport.QuestMachinePauseCorgi.prevSendNavEvents = false

protected

---

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

• C:/Dev/Quest Machine/Dev/Integration/Corgi Integration/Assets/Pixel Crushers/Quest Machine/Third Party Support/Corgi Support/Scripts/QuestMachinePauseCorgi.cs