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 Game.ScreenFade

Game Screen Fade class.

Main class. To fades the player's screen.

Data Structures

.screenFadeShowOption

The Game.ScreenFade:Show options.

Methods

Game.ScreenFade:Show ([Player=nil[, Duration=0[, HoldTime=0[, Flags=0[, ColorR=0[, ColorG=0[, ColorB=0[, Alpha=0]]]]]]]])	Shows the screen fade.
Game.ScreenFade:Hide ([player=nil])	Hides the screen fade.

Data Structures

.screenFadeShowOption

The Game.ScreenFade:Show options.

• player Game.Player or nil A player that receive screen fade. | All connected players will receive screen fade. (default nil)
• mode number 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

Game.ScreenFade:Show ([Player=nil[, Duration=0[, HoldTime=0[, Flags=0[, ColorR=0[, ColorG=0[, ColorB=0[, Alpha=0]]]]]]]])

Shows the screen fade.

Parameters:

• Player Game.Player, nil or .screenFadeShowOption A player that receive screen fade. | All connected players will receive screen fade. | Options table. (default nil)
• Duration number Fading duration (in second unit)(Ignored if player is a table). (default 0)
• HoldTime number Display duration after fading finished (in second unit)(Ignored if player is a table). (default 0)
• Flags number The screen fading bitflags (Ignored if player is a table). (default 0)
• ColorR number Red color composition (Ignored if player is a table). (default 0)
• ColorG number Green color composition (Ignored if player is a table). (default 0)
• ColorB number Blue color composition (Ignored if player is a table). (default 0)
• Alpha number Transparency (Ignored if player is a table). (default 0)

Returns:

self This class.

See also:

Common.ScreenFade.FFADE

Game.ScreenFade:Hide ([player=nil])

Hides the screen fade.

Parameters:

• player Game.Player or nil A player that removes his/her screen fade. | All connected players will removes their screen fade. (default nil)

Returns:

self This class.