PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer Class Reference

Add this component to the player prefab to block player input when Quest Machine sends "Pause Player" and "Unpause Player" messages, such as when opening and closing the dialogue UI. More...

Inheritance diagram for PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer:

Collaboration diagram for PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer:

Public Member Functions
void	OnMessage (MessageArgs messageArgs)
	Handles a message that the message handler is listening for.

Public Attributes
bool	blockPlayerInput = true
EventInteraction	pausePlayerEvent
EventInteraction	unpausePlayerEvent

Protected Member Functions
virtual void	OnEnable ()
virtual void	OnDisable ()
void	SetComponentEnabled< T > (bool value)

Detailed Description

Add this component to the player prefab to block player input when Quest Machine sends "Pause Player" and "Unpause Player" messages, such as when opening and closing the dialogue UI.

You can also assign events to execute on these messages.

Member Function Documentation

OnDisable()

virtual void PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer.OnDisable ( )

inlineprotectedvirtual

OnEnable()

virtual void PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer.OnEnable ( )

inlineprotectedvirtual

OnMessage()

void PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer.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.

SetComponentEnabled< T >()

void PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer.SetComponentEnabled< T > ( bool  value )

inlineprotected

Type Constraints

T

:

MonoBehaviour

Member Data Documentation

blockPlayerInput

bool PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer.blockPlayerInput = true

pausePlayerEvent

EventInteraction PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer.pausePlayerEvent

unpausePlayerEvent

EventInteraction PixelCrushers.QuestMachine.ORKSupport.ORKEventsOnPausePlayer.unpausePlayerEvent

---

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

• C:/Dev/Quest Machine/Dev/Integration/ORK Integration/Assets/Pixel Crushers/Quest Machine/Third Party Support/ORK Framework Support/Scripts/Utility/ORKEventsOnPausePlayer.cs