This component provides methods to freeze and unfreeze the UFPS player. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer:

Collaboration diagram for PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer:

Public Member Functions
delegate bool	CanShowCursorDelegate ()

void	OnConversationStart (Transform actor)
	When a conversation starts, freeze the UFPS player (i.e., gameplay) and show the cursor. More...

void	OnConversationEnd (Transform actor)
	When a conversation ends, unfreeze the UFPS player (i.e., gameplay) and restore the previous cursor state. More...

void	Freeze ()
	Freeze the UFPS player (i.e., gameplay) and show the cursor. More...

void	Unfreeze ()
	Unfreeze the UFPS player (i.e. More...

Public Attributes
bool	hideHUD = true

bool	freezeDuringConversations = true

bool	disableInputOnFreeze = true

bool	lockCursorOnStart = true

UnityEvent	onFreeze = new UnityEvent()

UnityEvent	onUnfreeze = new UnityEvent()

CanShowCursorDelegate	CanShowCursor = null

Detailed Description

This component provides methods to freeze and unfreeze the UFPS player.

It also freezes the player during conversations.

Member Function Documentation

◆ CanShowCursorDelegate()

delegate bool PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.CanShowCursorDelegate ( )

◆ Freeze()

void PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.Freeze ( )

Freeze the UFPS player (i.e., gameplay) and show the cursor.

◆ OnConversationEnd()

void PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.OnConversationEnd ( Transform actor )

When a conversation ends, unfreeze the UFPS player (i.e., gameplay) and restore the previous cursor state.

Parameters

actor Actor participating in the conversation.

◆ OnConversationStart()

void PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.OnConversationStart ( Transform actor )

When a conversation starts, freeze the UFPS player (i.e., gameplay) and show the cursor.

Parameters

actor Actor participating in the conversation.

◆ Unfreeze()

void PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.Unfreeze ( )

Unfreeze the UFPS player (i.e.

gameplay) and restore the previous cursor state.

Member Data Documentation

◆ CanShowCursor

CanShowCursorDelegate PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.CanShowCursor = null

◆ disableInputOnFreeze

bool PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.disableInputOnFreeze = true

◆ freezeDuringConversations

bool PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.freezeDuringConversations = true

◆ hideHUD

bool PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.hideHUD = true

◆ lockCursorOnStart

bool PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.lockCursorOnStart = true

◆ onFreeze

UnityEvent PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.onFreeze = new UnityEvent()

◆ onUnfreeze

UnityEvent PixelCrushers.DialogueSystem.UFPS.FPFreezePlayer.onUnfreeze = new UnityEvent()

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

D:/Documents/Unity Projects/Dialogue System/Dev/Integration/UFPS Integration/Assets/Dialogue System/Third Party Support/UFPS/Scripts/FPFreezePlayer.cs

Public Member Functions

Public Attributes