PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations Class Reference

Pauses TopDown and/or disables player input during conversations. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations:
Collaboration diagram for PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations:

Public Member Functions

virtual void Pause ()
 
virtual void Unpause ()
 

Public Attributes

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

Protected Member Functions

virtual void OnConversationStart (Transform actor)
 

Detailed Description

Pauses TopDown and/or disables player input during conversations.

If you add it to the Dialogue Manager, it will affect all conversations. If you add it to a player, it will only affect conversations that the player is involved in.

You can also add a copy of this component to a quest log window. Configure OnOpen() to call Pause and OnClose() to call Unpause. Untick the quest log window's Pause While Open and Unlock Cursor While Open checkboxes since this script will handle it.

You can add an MMCursorVisible component to the dialogue UI's Dialogue Panel or quest log window's Main Panel to show the cursor while open.

Member Function Documentation

◆ OnConversationStart()

virtual void PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations.OnConversationStart ( Transform  actor)
inlineprotectedvirtual

◆ Pause()

virtual void PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations.Pause ( )
inlinevirtual

◆ Unpause()

virtual void PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations.Unpause ( )
inlinevirtual

Member Data Documentation

◆ boolAnimatorParametersToStop

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

◆ disableInputDuringConversations

bool PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations.disableInputDuringConversations = true

◆ floatAnimatorParametersToStop

string [] PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations.floatAnimatorParametersToStop = new string[] { "Speed" }

◆ pauseDuringConversations

bool PixelCrushers.DialogueSystem.TopDownEngineSupport.PauseTopDownDuringConversations.pauseDuringConversations = true

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