Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.MainMenus.Interactive.IMMMenuFader Class Reference

Menu fader for interactive main menu. More...

Inheritance diagram for Dragengine.Gui.MainMenus.Interactive.IMMMenuFader:

Public Member Functions

void dispose ()
 Dispose of widget. More...
 
void fadeTo (float transparency, float fadeTime)
 Fade to transparency. More...
 
float getCurTransparency ()
 Current transparency. More...
 
float getElapsed ()
 Elapsed fade time. More...
 
float getFadeTime ()
 Fade time. More...
 
InteractiveMainMenu getMainMenu ()
 Interactive main menu. More...
 
float getTargetTransparency ()
 Camera transparency to fade to or null. More...
 
bool isFading ()
 Widget is fading. More...
 
IMMMenuFader new (InteractiveMainMenu mainMenu)
 Create widget fader for interactive main menu. More...
 
void setCurTransparency (float transparency)
 Set current transparency. More...
 
void update (float elapsed)
 Update fading. More...
 

Protected Member Functions

void setMousePointerFade (float transparency)
 Set mouse pointer fade if possible. More...
 
void updateMenuFade ()
 Update menu fade. More...
 

Detailed Description

Menu fader for interactive main menu.

Fades menu over black.

Member Function Documentation

◆ dispose()

void Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.dispose ( )

Dispose of widget.

◆ fadeTo()

void Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.fadeTo ( float  transparency,
float  fadeTime 
)

Fade to transparency.

Starts fading.

◆ getCurTransparency()

float Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.getCurTransparency ( )

Current transparency.

◆ getElapsed()

float Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.getElapsed ( )

Elapsed fade time.

◆ getFadeTime()

float Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.getFadeTime ( )

Fade time.

◆ getMainMenu()

InteractiveMainMenu Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.getMainMenu ( )

Interactive main menu.

◆ getTargetTransparency()

float Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.getTargetTransparency ( )

Camera transparency to fade to or null.

◆ isFading()

bool Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.isFading ( )

Widget is fading.

◆ new()

IMMMenuFader Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.new ( InteractiveMainMenu  mainMenu)

Create widget fader for interactive main menu.

◆ setCurTransparency()

void Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.setCurTransparency ( float  transparency)

Set current transparency.

Stops fading if running.

◆ setMousePointerFade()

void Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.setMousePointerFade ( float  transparency)
protected

Set mouse pointer fade if possible.

◆ update()

void Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.update ( float  elapsed)

Update fading.

◆ updateMenuFade()

void Dragengine.Gui.MainMenus.Interactive.IMMMenuFader.updateMenuFade ( )
protected

Update menu fade.


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