Public Types | Public Member Functions | Static Public Attributes | Properties | List of all members
PixelCrushers.DialogueSystem.UIShowHideController Class Reference

This is a deprecated class that has been replaced by UIAnimatorMonitor in StandardDialogueUI and elsewhere. More...

Public Types

enum  TransitionMode { State , Trigger }
 
enum  State {
  Undefined , Showing , Shown , Hiding ,
  Hidden
}
 

Public Member Functions

 UIShowHideController (GameObject gameObjectToControl, Component panelToControl, TransitionMode animationMode=TransitionMode.Trigger, bool debug=false)
 
void Show (string showState, bool pauseAfterAnimation, System.Action callback, bool wait=true)
 
void Hide (string hideState, System.Action callback)
 
void ClearTrigger (string triggerName)
 

Static Public Attributes

static float maxWaitDuration = 5
 Maximum number of seconds to wait for show/hide animation.
 

Properties

Component panel [get, set]
 
State state [get, set]
 
bool debug [get, set]
 

Detailed Description

This is a deprecated class that has been replaced by UIAnimatorMonitor in StandardDialogueUI and elsewhere.

It's only used by the older UnityUIDialogueUI.

Member Enumeration Documentation

◆ State

enum PixelCrushers.DialogueSystem.UIShowHideController.State
Enumerator
Undefined 
Showing 
Shown 
Hiding 
Hidden 

◆ TransitionMode

enum PixelCrushers.DialogueSystem.UIShowHideController.TransitionMode
Enumerator
State 
Trigger 

Constructor & Destructor Documentation

◆ UIShowHideController()

PixelCrushers.DialogueSystem.UIShowHideController.UIShowHideController ( GameObject  gameObjectToControl,
Component  panelToControl,
TransitionMode  animationMode = TransitionMode::Trigger,
bool  debug = false 
)
inline

Member Function Documentation

◆ ClearTrigger()

void PixelCrushers.DialogueSystem.UIShowHideController.ClearTrigger ( string  triggerName)
inline

◆ Hide()

void PixelCrushers.DialogueSystem.UIShowHideController.Hide ( string  hideState,
System::Action  callback 
)
inline

◆ Show()

void PixelCrushers.DialogueSystem.UIShowHideController.Show ( string  showState,
bool  pauseAfterAnimation,
System::Action  callback,
bool  wait = true 
)
inline

Member Data Documentation

◆ maxWaitDuration

float PixelCrushers.DialogueSystem.UIShowHideController.maxWaitDuration = 5
static

Maximum number of seconds to wait for show/hide animation.

Property Documentation

◆ debug

bool PixelCrushers.DialogueSystem.UIShowHideController.debug
getset

◆ panel

Component PixelCrushers.DialogueSystem.UIShowHideController.panel
getset

◆ state

State PixelCrushers.DialogueSystem.UIShowHideController.state
getset
The documentation for this class was generated from the following file: