Donxon SDK

• Index

Contents

• Data Structures
• Fields
• Methods
• Metamethods

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.ProgressBar

UI Progress Bar class.

For drawing progress bars.

Data Structures

.progressBarFlexibleBarOption	Progress Bar's flexible bar options.
.progressBarOption	Progress Bar options.

Fields

UI.ProgressBar._base	The base class.
UI.ProgressBar._parent	The parent class.
UI.ProgressBar.bar	The flexible bar.

Methods

UI.ProgressBar:Create ()	Creates a progress bar.
UI.ProgressBar:Show ()	Shows this progress bar to the screen.
UI.ProgressBar:Hide ()	Hides this progress bar from the screen.
UI.ProgressBar:IsVisible ()	Checks whether this progress bar is visible on the screen.
UI.ProgressBar:Set (arg)	Sets this progress bar's options.
UI.ProgressBar:Get ()	Gets this progress bar's options.

Metamethods

UI.ProgressBar.__index

Base class.

Data Structures

.progressBarFlexibleBarOption

Progress Bar's flexible bar options.

• percent number Progress percentage (Range = 0~1). (optional)
• r integer Red color composition (Range = 0~255). (optional)
• g integer Green color composition (Range = 0~255). (optional)
• b integer Blue color composition (Range = 0~255). (optional)
• a integer Transparency (Range = 0~255). (default 255)

.progressBarOption

Progress Bar options.

• ... .rectangleOption All rectangle options are applied here. (optional)
• bar .progressBarFlexibleBarOption The bar options. (optional)

Fields

UI.ProgressBar._base

The base class.

• _base UI.Box

UI.ProgressBar._parent

The parent class.

• _parent UI.Rectangle

UI.ProgressBar.bar

The flexible bar.

• bar UI.Box

Methods

UI.ProgressBar:Create ()

Creates a progress bar.

Returns:

UI.ProgressBar This progress bar.

UI.ProgressBar:Show ()

Shows this progress bar to the screen.

Returns:

UI.ProgressBar This progress bar.

UI.ProgressBar:Hide ()

Hides this progress bar from the screen.

Returns:

UI.ProgressBar This progress bar.

UI.ProgressBar:IsVisible ()

Checks whether this progress bar is visible on the screen.

Returns:

bool Returns true if visible.

UI.ProgressBar:Set (arg)

Sets this progress bar's options.

Parameters:

• arg .progressBarOption The progress bar options to set.

Returns:

UI.ProgressBar This progress bar.

UI.ProgressBar:Get ()

Gets this progress bar's options.

Returns:

.progressBarOption The options table.

Metamethods

UI.ProgressBar.__index

Base class.

• __index UI.ProgressBar