SCR_RadialProgressBarUIComponent Class Reference

Inheritance diagram for SCR_RadialProgressBarUIComponent:

Protected Member Functions
void	SetProgress (float progress)
void	SetPreviewProgress (float progress)
float	GetProgress ()
ImageWidget	GetRadialProgressBarWidget ()
ImageWidget	GetBackgroundWidget ()
void	SetProgressBarImage (ResourceName RadialProgressBarImage)
void	SetBackgroundImage (ResourceName BackgroundImage)
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

Detailed Description

Definition at line 1 of file SCR_RadialProgressBarUIComponent.c.

Member Function Documentation

GetBackgroundWidget()

ImageWidget SCR_RadialProgressBarUIComponent::GetBackgroundWidget ( )

inlineprotected

Get radial progress bar background image widget.

Returns

ImageWidget radial progress bar background image widget

Definition at line 98 of file SCR_RadialProgressBarUIComponent.c.

GetOnProgressEmpty()

ScriptInvoker SCR_RadialProgressBarUIComponent::GetOnProgressEmpty ( )

inlineprotected

Definition at line 128 of file SCR_RadialProgressBarUIComponent.c.

GetOnProgressFull()

ScriptInvoker SCR_RadialProgressBarUIComponent::GetOnProgressFull ( )

inlineprotected

Definition at line 123 of file SCR_RadialProgressBarUIComponent.c.

GetProgress()

float SCR_RadialProgressBarUIComponent::GetProgress ( )

inlineprotected

Get the progress value

Returns

float progress value between min and max value

Definition at line 80 of file SCR_RadialProgressBarUIComponent.c.

GetRadialProgressBarWidget()

ImageWidget SCR_RadialProgressBarUIComponent::GetRadialProgressBarWidget ( )

inlineprotected

Get radial progress bar image widget.

Returns

ImageWidget radial progress bar image widget

Definition at line 89 of file SCR_RadialProgressBarUIComponent.c.

HandlerAttached()

override void SCR_RadialProgressBarUIComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 134 of file SCR_RadialProgressBarUIComponent.c.

SetBackgroundImage()

void SCR_RadialProgressBarUIComponent::SetBackgroundImage ( ResourceName BackgroundImage )

inlineprotected

Set radial progress bar background image.

Parameters

BackgroundImage

image to set

Definition at line 117 of file SCR_RadialProgressBarUIComponent.c.

SetPreviewProgress()

void SCR_RadialProgressBarUIComponent::SetPreviewProgress ( float progress )

inlineprotected

Set the progress of the preview bar. Takes a value between 0 and 1

Parameters

progress

value between 0 and 1

Definition at line 64 of file SCR_RadialProgressBarUIComponent.c.

SetProgress()

void SCR_RadialProgressBarUIComponent::SetProgress ( float progress )

inlineprotected

Set the progress. Takes a value between min and max value

Parameters

progress

value between min and max value

Definition at line 37 of file SCR_RadialProgressBarUIComponent.c.

SetProgressBarImage()

void SCR_RadialProgressBarUIComponent::SetProgressBarImage ( ResourceName RadialProgressBarImage )

inlineprotected

Set radial progress bar image.

Parameters

RadialProgressBarImage

image to set

Definition at line 107 of file SCR_RadialProgressBarUIComponent.c.

Member Data Documentation

Event_OnProgressEmpty

ref ScriptInvoker SCR_RadialProgressBarUIComponent::Event_OnProgressEmpty = new ScriptInvoker

protected

Definition at line 29 of file SCR_RadialProgressBarUIComponent.c.

Event_OnProgressFull

ref ScriptInvoker SCR_RadialProgressBarUIComponent::Event_OnProgressFull = new ScriptInvoker

protected

Definition at line 28 of file SCR_RadialProgressBarUIComponent.c.

m_bIsMirrored

bool SCR_RadialProgressBarUIComponent::m_bIsMirrored

protected

Definition at line 13 of file SCR_RadialProgressBarUIComponent.c.

m_bProgressFull

bool SCR_RadialProgressBarUIComponent::m_bProgressFull

protected

Definition at line 31 of file SCR_RadialProgressBarUIComponent.c.

m_fMaxValue

float SCR_RadialProgressBarUIComponent::m_fMaxValue

protected

Definition at line 10 of file SCR_RadialProgressBarUIComponent.c.

m_fMinValue

float SCR_RadialProgressBarUIComponent::m_fMinValue

protected

Definition at line 7 of file SCR_RadialProgressBarUIComponent.c.

m_iProgress

float SCR_RadialProgressBarUIComponent::m_iProgress

protected

Definition at line 4 of file SCR_RadialProgressBarUIComponent.c.

m_sBackgroundName

string SCR_RadialProgressBarUIComponent::m_sBackgroundName

protected

Definition at line 22 of file SCR_RadialProgressBarUIComponent.c.

m_sRadialProgressBarName

string SCR_RadialProgressBarUIComponent::m_sRadialProgressBarName

protected

Definition at line 16 of file SCR_RadialProgressBarUIComponent.c.

m_sRadialProgressPreviewName

string SCR_RadialProgressBarUIComponent::m_sRadialProgressPreviewName

protected

Definition at line 19 of file SCR_RadialProgressBarUIComponent.c.

m_wBackground

ImageWidget SCR_RadialProgressBarUIComponent::m_wBackground

protected

Definition at line 26 of file SCR_RadialProgressBarUIComponent.c.

m_wRadialProgressBar

ImageWidget SCR_RadialProgressBarUIComponent::m_wRadialProgressBar

protected

Definition at line 24 of file SCR_RadialProgressBarUIComponent.c.

m_wRadialProgressPreview

ImageWidget SCR_RadialProgressBarUIComponent::m_wRadialProgressPreview

protected

Definition at line 25 of file SCR_RadialProgressBarUIComponent.c.

---

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

• scripts/Game/UI/HUD/SCR_RadialProgressBarUIComponent.c