SCR_RadialProgressBarUIComponent Interface Reference

Inheritance diagram for SCR_RadialProgressBarUIComponent:

Public Member Functions
void	SetProgress (float progress)
	Set the progress.
void	SetPreviewProgress (float progress)
	Set the progress of the preview bar.
float	GetProgress ()
	Get the progress value.
ImageWidget	GetRadialProgressBarWidget ()
	Get radial progress bar image widget.
ImageWidget	GetBackgroundWidget ()
	Get radial progress bar background image widget.
void	SetProgressBarImage (ResourceName RadialProgressBarImage)
	Set radial progress bar image.
void	SetBackgroundImage (ResourceName BackgroundImage)
	Set radial progress bar background image.
ScriptInvoker	GetOnProgressFull ()
ScriptInvoker	GetOnProgressEmpty ()
override void	HandlerAttached (Widget w)

Protected Attributes
float	m_iProgress
float	m_fMinValue
float	m_fMaxValue
bool	m_bIsMirrored
string	m_sRadialProgressBarName
string	m_sRadialProgressPreviewName
string	m_sBackgroundName
ImageWidget	m_wRadialProgressBar
ImageWidget	m_wRadialProgressPreview
ImageWidget	m_wBackground
ref ScriptInvoker	Event_OnProgressFull = new ScriptInvoker
ref ScriptInvoker	Event_OnProgressEmpty = new ScriptInvoker
bool	m_bProgressFull

Member Function Documentation

GetBackgroundWidget()

ImageWidget SCR_RadialProgressBarUIComponent.GetBackgroundWidget

(

)

Get radial progress bar background image widget.

Returns

ImageWidget radial progress bar background image widget

GetOnProgressEmpty()

ScriptInvoker SCR_RadialProgressBarUIComponent.GetOnProgressEmpty

(

)

GetOnProgressFull()

ScriptInvoker SCR_RadialProgressBarUIComponent.GetOnProgressFull

(

)

GetProgress()

float SCR_RadialProgressBarUIComponent.GetProgress

(

)

Get the progress value.

Returns

float progress value between min and max value

GetRadialProgressBarWidget()

ImageWidget SCR_RadialProgressBarUIComponent.GetRadialProgressBarWidget

(

)

Get radial progress bar image widget.

Returns

ImageWidget radial progress bar image widget

HandlerAttached()

override void SCR_RadialProgressBarUIComponent.HandlerAttached

(

Widget

w

)

Implemented in SCR_ImageRadialProgressBarUIComponent.

SetBackgroundImage()

void SCR_RadialProgressBarUIComponent.SetBackgroundImage

(

ResourceName

BackgroundImage

)

Set radial progress bar background image.

Parameters

BackgroundImage

image to set

SetPreviewProgress()

void SCR_RadialProgressBarUIComponent.SetPreviewProgress

(

float

progress

)

Set the progress of the preview bar.

Takes a value between 0 and 1

Parameters

progress

value between 0 and 1

SetProgress()

void SCR_RadialProgressBarUIComponent.SetProgress

(

float

progress

)

Set the progress.

Takes a value between min and max value

Parameters

progress

value between min and max value

Implemented in SCR_ImageRadialProgressBarUIComponent.

SetProgressBarImage()

void SCR_RadialProgressBarUIComponent.SetProgressBarImage

(

ResourceName

RadialProgressBarImage

)

Set radial progress bar image.

Parameters

RadialProgressBarImage

image to set

Member Data Documentation

Event_OnProgressEmpty

ref ScriptInvoker SCR_RadialProgressBarUIComponent.Event_OnProgressEmpty = new ScriptInvoker

protected

Event_OnProgressFull

ref ScriptInvoker SCR_RadialProgressBarUIComponent.Event_OnProgressFull = new ScriptInvoker

protected

m_bIsMirrored

bool SCR_RadialProgressBarUIComponent.m_bIsMirrored

protected

m_bProgressFull

bool SCR_RadialProgressBarUIComponent.m_bProgressFull

protected

m_fMaxValue

float SCR_RadialProgressBarUIComponent.m_fMaxValue

protected

m_fMinValue

float SCR_RadialProgressBarUIComponent.m_fMinValue

protected

m_iProgress

float SCR_RadialProgressBarUIComponent.m_iProgress

protected

m_sBackgroundName

string SCR_RadialProgressBarUIComponent.m_sBackgroundName

protected

m_sRadialProgressBarName

string SCR_RadialProgressBarUIComponent.m_sRadialProgressBarName

protected

m_sRadialProgressPreviewName

string SCR_RadialProgressBarUIComponent.m_sRadialProgressPreviewName

protected

m_wBackground

ImageWidget SCR_RadialProgressBarUIComponent.m_wBackground

protected

m_wRadialProgressBar

ImageWidget SCR_RadialProgressBarUIComponent.m_wRadialProgressBar

protected

m_wRadialProgressPreview

ImageWidget SCR_RadialProgressBarUIComponent.m_wRadialProgressPreview

protected

---

The documentation for this interface was generated from the following file:

• Game/UI/HUD/SCR_RadialProgressBarUIComponent.c