#include <guiProgressCtrl_ScriptBinding.h>

Public Member Functions
Integer	getAnimationTime ()"

Float	getDisplayProgress ()"

Float	getProgress ()"

void	resetProgress ()"

void	setAnimationTime (S32 time)"

void	setProgress (F32 progress, [S32 time])"

Public Member Functions inherited from GuiControl
void	addGuiControl (int controlId)

Integer	findHitControl (int x, int y)

String	getCenter ()

String	getExtent (...)

String	getGlobalCenter ()

String	getGlobalPosition ()

String	getMinExtent ()

Integer	getParent ()

String	getPosition ()

String	getText ()

Boolean	getTextExtend ()

Boolean	getTextWrap ()

String	getValue ()

Boolean	isActive ()

Boolean	isAwake ()

Boolean	isVisible ()

void	makeFirstResponder (isFirst)

void	performClick ()

Boolean	pointInControl (int x, int y)

void	reorderChild (child1, child2)

void	resize (int x, int y, int w, int h)

void	setActive (isActive)

void	setCanSave (bool canSave)

void	setCenter (int x, int y)

void	setExtent (int width, int height)

void	setFirstResponder ()

void	setPosition (int x, int y)

void	setPositionGlobal (int x, int y)

void	setProfile (GuiControlProfile p)

void	setText (text)

void	setTextExtend (setting)

void	setTextID (id)

void	setTextWrap (setting)

void	setValue (value)

void	setVisible (isVisible)

Member Function Documentation

◆ getAnimationTime()

Integer getAnimationTime ( )

Gets the time it takes in milliseconds for the progress bar to animate to its set progress.

Float getDisplayProgress ( )

Returns the currently displayed progress. This may be differnt if the animation to the most recently set progress is still running.

Float getProgress ( )

Returns the current progress.

void resetProgress ( )

Sets the progress bar back to the start.

void setAnimationTime ( S32 time )

Sets the amount of time in milliseconds that it will take to animate each time the progress is updated.

Parameters

time	The animation time in milliseconds.

void setProgress ( F32 progress )

Sets the current progress. The smoothly animate to the given progress over the optional time or previously used time.

Parameters

progress	The updated progress of the progress bar as a decimal value between 0 and 1.
time	The optional time in milliseconds it will take to animate from the progress bar's current position to the updated one.