PlatformerPro.Extras.UIDialog Class Reference

Displays a GameObject (which typically has text information in it). More...

Inheritance diagram for PlatformerPro.Extras.UIDialog:

Public Member Functions
virtual void	ShowDialog ()
	Shows the dialog. More...
virtual void	ShowDialog (Transform worldPosition)
	Shows the dialog. More...
virtual void	HideDialog ()
	Hides the dialog. More...

Public Attributes
float	autoHideTime
	Time (in seconds) before the box is hidden after showing. Use 0 to disable auto hide. More...
List< FX_Base >	showEffects
	Effects to play on show. More...
List< FX_Base >	hideEffects
	The hide effects. More...
GameObject	target
	Object to activate on show and deactivate on hide. Can be null if you use effects. More...
Transform	worldPosition
	Where in the world should this object be shown. More...
bool	updateWorldPositionEachFrame = true
	Should we update world position each frame (use to allow pixel perfect placement in world position). More...

Protected Member Functions
virtual IEnumerator	AutoHide ()
	Coroutine to autohide the dialog. More...
virtual IEnumerator	CheckForTyperHide ()
	Coroutine to check for closing of a dialog typer. More...

Protected Attributes
UIDialogTyper	dialogTyper
	Reference to the dialog typer or null if there isn't one. More...
bool	visible
	Tracks if we are visible or not. More...

Properties
bool	Visible [get]
	Are we visible? More...

Detailed Description

Displays a GameObject (which typically has text information in it).

Member Function Documentation

AutoHide()

virtual IEnumerator PlatformerPro.Extras.UIDialog.AutoHide ( )

protectedvirtual

Coroutine to autohide the dialog.

CheckForTyperHide()

virtual IEnumerator PlatformerPro.Extras.UIDialog.CheckForTyperHide ( )

protectedvirtual

Coroutine to check for closing of a dialog typer.

Returns

The for typer hide.

HideDialog()

virtual void PlatformerPro.Extras.UIDialog.HideDialog ( )

virtual

Hides the dialog.

ShowDialog() [1/2]

virtual void PlatformerPro.Extras.UIDialog.ShowDialog ( )

virtual

Shows the dialog.

ShowDialog() [2/2]

virtual void PlatformerPro.Extras.UIDialog.ShowDialog ( Transform  worldPosition )

virtual

Shows the dialog.

Parameters

worldPosition

World position to use. Only applied if world position is not already set.

Member Data Documentation

autoHideTime

float PlatformerPro.Extras.UIDialog.autoHideTime

Time (in seconds) before the box is hidden after showing. Use 0 to disable auto hide.

dialogTyper

UIDialogTyper PlatformerPro.Extras.UIDialog.dialogTyper

protected

Reference to the dialog typer or null if there isn't one.

hideEffects

List<FX_Base> PlatformerPro.Extras.UIDialog.hideEffects

The hide effects.

showEffects

List<FX_Base> PlatformerPro.Extras.UIDialog.showEffects

Effects to play on show.

target

GameObject PlatformerPro.Extras.UIDialog.target

Object to activate on show and deactivate on hide. Can be null if you use effects.

updateWorldPositionEachFrame

bool PlatformerPro.Extras.UIDialog.updateWorldPositionEachFrame = true

Should we update world position each frame (use to allow pixel perfect placement in world position).

visible

bool PlatformerPro.Extras.UIDialog.visible

protected

Tracks if we are visible or not.

worldPosition

Transform PlatformerPro.Extras.UIDialog.worldPosition

Where in the world should this object be shown.

Property Documentation

Visible

bool PlatformerPro.Extras.UIDialog.Visible

get

Are we visible?

---

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

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/UI/InGameUI/Legacy/UIDialog.cs