Donxon SDK

• Index

Contents

• Data Structures
• Methods

Classes

• Debug
• StringBuffer
• Hook
• System.UTF8
• Common.Color
• Common.Vector2D
• Common.Vector
• Common.NetMessage
• Common.TextMenu
• Common.ScreenFade
• Common.HUDText
• Game.NetMessage
• Game.TextMenu
• Game.ScreenFade
• Game.BarTime
• UI.Rectangle
• UI.ProgressBar
• UI.TextMenu
• UI.ScreenFade
• UI.BarTime

Globals

• Properties
• Functions
• Classes

Modules

• System
• Common
• Game
• UI

Topics

• changelog
• credit
• license

Examples

• bartime.game.lua
• bartime.ui.lua
• deltatiming.game.lua
• deltatiming.ui.lua
• hook.game.lua
• netmsg.simple.common.lua
• netmsg.simple.game.lua
• netmsg.simple.ui.lua
• progressbar.ui.lua
• rectangle.ui.lua
• screenfade.game.lua
• screenfade.ui.lua
• stringbuffer.lua
• textmenu.simple.game.lua
• utf8.lua
• vector.2d.lua
• vector.3d.lua

Class UI.ScreenFade

UI Screen Fade class.

To fades the screen.

Data Structures

.screenFadeDrawOption

The UI.ScreenFade:Draw options.

Methods

UI.ScreenFade:Draw ([Duration=0[, HoldTime=0[, Flags=0[, ColorR=0[, ColorG=0[, ColorB=0[, Alpha=0]]]]]]])	Draws the screen fade.
UI.ScreenFade:Hide ()	Hides the screen fade.
UI.ScreenFade:IsVisible ()	Checks whether the screen fade is visible.

Data Structures

.screenFadeDrawOption

The UI.ScreenFade:Draw options.

• mode Common.ScreenFade.FFADE Fading mode. (default Common.ScreenFade.FFADE.IN)
• modulate bool Modulate (don't blend). (default false)
• duration number Fading duration (in second unit). (default 0)
• holdTime number Display duration after fading finished (in second unit). (default 0)
• r number Red color composition. (default 0)
• g number Green color composition. (default 0)
• b number Blue color composition. (default 0)
• a number Transparency. (default 0)

See also:

Common.ScreenFade.FFADE

Methods

UI.ScreenFade:Draw ([Duration=0[, HoldTime=0[, Flags=0[, ColorR=0[, ColorG=0[, ColorB=0[, Alpha=0]]]]]]])

Draws the screen fade.

Parameters:

• Duration number or .screenFadeDrawOption Fading duration (in second unit). | Options table. (default 0)
• HoldTime number Display duration after fading finished (in second unit)(Ignored if Duration is a table). (default 0)
• Flags number The screen fading bitflags (Ignored if Duration is a table). (default 0)
• ColorR number Red color composition (Ignored if Duration is a table). (default 0)
• ColorG number Green color composition (Ignored if Duration is a table). (default 0)
• ColorB number Blue color composition (Ignored if Duration is a table). (default 0)
• Alpha number Transparency (Ignored if Duration is a table). (default 0)

Returns:

self This class.

See also:

Common.ScreenFade.FFADE

UI.ScreenFade:Hide ()

Hides the screen fade.

Returns:

self This class.

UI.ScreenFade:IsVisible ()

Checks whether the screen fade is visible.

Returns:

bool Returns true if visible.