PlatformerPro.UISceneLoaderOverlay Class Reference

User interface scene loader overlay. More...

Inheritance diagram for PlatformerPro.UISceneLoaderOverlay:

Public Attributes
GameObject	visibleContent
	Content to show when we load a new scene. More...
List< string >	ignoredScenes
	Names of scenes for which we will NOT show the loading overlay (for example main menu scene). More...

Protected Member Functions
virtual void	Init ()
	Init this instance for the current scene. More...
virtual void	PhaseChange (object sender, GamePhaseEventArgs e)
	Handles phase change. More...
virtual void	WillExitScene (object sender, SceneEventArgs e)
	Handles a scene exit More...

Properties
static UISceneLoaderOverlay	Instance [get, protected set]
	Gets or sets the instance. 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...

Additional Inherited Members
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...

Detailed Description

User interface scene loader overlay.

Member Function Documentation

Init()

virtual void PlatformerPro.UISceneLoaderOverlay.Init ( )

protectedvirtual

Init this instance for the current scene.

PhaseChange()

virtual void PlatformerPro.UISceneLoaderOverlay.PhaseChange ( object  sender, GamePhaseEventArgs  e  )

protectedvirtual

Handles phase change.

Parameters

sender	Sender.
e	Event args.

WillExitScene()

virtual void PlatformerPro.UISceneLoaderOverlay.WillExitScene ( object  sender, SceneEventArgs  e  )

protectedvirtual

Handles a scene exit

Parameters

sender	Sender.
e	Event args.

Member Data Documentation

ignoredScenes

List<string> PlatformerPro.UISceneLoaderOverlay.ignoredScenes

Names of scenes for which we will NOT show the loading overlay (for example main menu scene).

visibleContent

GameObject PlatformerPro.UISceneLoaderOverlay.visibleContent

Content to show when we load a new scene.

Property Documentation

Instance

UISceneLoaderOverlay PlatformerPro.UISceneLoaderOverlay.Instance

staticgetprotected set

Gets or sets the instance.

The instance.

---

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

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