A screen is a user interface component that can be shown and hidden. More...

Inheritance diagram for PlatformerPro.Extras.UIScreen:

Public Member Functions
virtual void	Show ()
	Show this menu. More...

virtual void	Hide ()
	Hide this menu. More...

Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void	Validate (PlatformerProMonoBehaviour myTarget)
	Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...

Public Attributes
GameObject	visibleComponent
	The pointer image. More...

List< FX_Base >	showEffects
	The show effects. More...

List< FX_Base >	hideEffects
	The hide effects. More...

Protected Member Functions
virtual IEnumerator	DoShow ()
	Do the show. More...

virtual IEnumerator	DoHide ()
	Do the hide. More...

Properties
override string	Header `[get]`
	Gets the header string used to describe the component. More...

bool	IsVisible `[get]`
	Gets a value indicating whether this T:PlatformerPro.Extras.UIScreen is visible. More...

Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string	Header `[get]`
	Gets the header string used to describe the component. More...

virtual string	DocLink `[get]`
	Gets a link to documentation site. More...

virtual string	VideoLink `[get]`
	Gets a link to a youtube video. More...

virtual string	Deprecated `[get]`
	If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...

Detailed Description

A screen is a user interface component that can be shown and hidden.

Member Function Documentation

◆ DoHide()

virtual IEnumerator PlatformerPro.Extras.UIScreen.DoHide ( )

protectedvirtual

Do the hide.

◆ DoShow()

virtual IEnumerator PlatformerPro.Extras.UIScreen.DoShow ( )

protectedvirtual

Do the show.

◆ Hide()

virtual void PlatformerPro.Extras.UIScreen.Hide ( )

virtual

Hide this menu.

Reimplemented in PlatformerPro.Extras.UIPauseMenu, and PlatformerPro.Extras.UIBasicMenu.

◆ Show()

virtual void PlatformerPro.Extras.UIScreen.Show ( )

virtual

Show this menu.

Reimplemented in PlatformerPro.Extras.UIBasicMenu.

Member Data Documentation

◆ hideEffects

List<FX_Base> PlatformerPro.Extras.UIScreen.hideEffects

The hide effects.

◆ showEffects

List<FX_Base> PlatformerPro.Extras.UIScreen.showEffects

The show effects.

◆ visibleComponent

GameObject PlatformerPro.Extras.UIScreen.visibleComponent

The pointer image.

Property Documentation

◆ Header

override string PlatformerPro.Extras.UIScreen.Header

get

Gets the header string used to describe the component.

The header.

◆ IsVisible

bool PlatformerPro.Extras.UIScreen.IsVisible

get

Gets a value indicating whether this T:PlatformerPro.Extras.UIScreen is visible.

true if is visible; otherwise, false.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/UI/UIScreen.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties