Antura  1.1.0
Antura.UI.SceneTransitioner Class Reference

Controls the transition animation between two scenes. More...

Inheritance diagram for Antura.UI.SceneTransitioner:

Public Member Functions

void CloseImmediate ()
 

Static Public Member Functions

static void Show (bool _doShow, Action _onComplete=null)
 Call this to show/hide the scene transitioner. More...
 

Public Attributes

float AnimationDuration = 0.75f
 
Image MaskCover
 
Image Icon
 
RectTransform Badge
 

Properties

static bool IsShown [get]
 
static bool IsPlaying [get]
 

Detailed Description

Controls the transition animation between two scenes.

Member Function Documentation

◆ CloseImmediate()

void Antura.UI.SceneTransitioner.CloseImmediate ( )

◆ Show()

static void Antura.UI.SceneTransitioner.Show ( bool  _doShow,
Action  _onComplete = null 
)
static

Call this to show/hide the scene transitioner.

Parameters
_doShowIf TRUE animates the transition IN and stops when the screen is covered, otherwise animates OUT
_onCompleteEventual callback to call when the transition IN/OUT completes

Member Data Documentation

◆ AnimationDuration

float Antura.UI.SceneTransitioner.AnimationDuration = 0.75f

◆ Badge

RectTransform Antura.UI.SceneTransitioner.Badge

◆ Icon

Image Antura.UI.SceneTransitioner.Icon

◆ MaskCover

Image Antura.UI.SceneTransitioner.MaskCover

Property Documentation

◆ IsPlaying

bool Antura.UI.SceneTransitioner.IsPlaying
staticget

◆ IsShown

bool Antura.UI.SceneTransitioner.IsShown
staticget

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