class ProgressBar

package minimalcomps.components

extends Component

A progress bar component for showing a changing value in relation to a total.

Constructor

new (?parent:DisplayObjectContainer, ?xpos:Float, ?ypos:Float)

Constructor

Parameters:

parent

The parent DisplayObjectContainer on which to add this ProgressBar.

xpos

The x position to place this component.

ypos

The y position to place this component.

Variables

maximum:Float

Gets / sets the maximum value of the ProgressBar.

value:Float

Gets / sets the current value of the ProgressBar.

Methods

draw ():Void

Draws the visual ui of the component.

get_maximum ():Float

get_value ():Float

set_maximum (value:Float):Float

set_value (value:Float):Float

Inherited Variables

Defined by Component

enabled:Bool

Sets/gets whether this component is enabled or not.

tag:Int

Sets/gets in integer that can identify the component.

Inherited Methods

Defined by Component

get_enabled ():Bool

get_height ():Float

get_tag ():Int

get_width ():Float

move (xpos:Float, ypos:Float):Void

Moves the component to the specified position.

Parameters:

xpos

the x position to move the component

ypos

the y position to move the component

setSize (w:Float, h:Float):Void

Sets the size of the component.

Parameters:

w

The width of the component.

h

The height of the component.

set_enabled (value:Bool):Bool

set_height (value:Float):Void

Sets/gets the height of the component.

set_tag (value:Int):Int

set_width (value:Float):Void

Sets/gets the width of the component.

set_x (value:Float):Void

Overrides the setter for x to always place the component on a whole pixel.

set_y (value:Float):Void

Overrides the setter for y to always place the component on a whole pixel.