SCR_AvailableActionContext Class Reference

Inheritance diagram for SCR_AvailableActionContext:

Protected Member Functions
string	ToString (bool forceText=true)
string	GetActionName ()
string	GetUIName ()
bool	IsAvailable (notnull SCR_AvailableActionsConditionData data, float timeSlice)
bool	IsDelayed ()
	returns true if action display is currently counting down twords its delayed fade in or out
void	ResetTimers ()
	Reset fade in and fade out timers to their default values.

Protected Attributes
bool	m_bEnabled
int	m_iTimeForHide
int	m_iTimeToShow
ref array< ref SCR_AvailableActionCondition >	m_aConditions
string	m_sTag
string	m_sAction
string	m_sName
const string	MARKUP_FORMAT = "<action name=\"%1\"/>"
float	m_fShowCountdown = m_iTimeToShow
float	m_fHideCountdown = m_iTimeForHide

Detailed Description

Definition at line 146 of file SCR_AvailableActionsDisplay.c.

Member Function Documentation

GetActionName()

string SCR_AvailableActionContext::GetActionName ( )

inlineprotected

Definition at line 187 of file SCR_AvailableActionsDisplay.c.

GetUIName()

string SCR_AvailableActionContext::GetUIName ( )

inlineprotected

Definition at line 195 of file SCR_AvailableActionsDisplay.c.

IsAvailable()

bool SCR_AvailableActionContext::IsAvailable ( notnull SCR_AvailableActionsConditionData data, float timeSlice )

inlineprotected

Definition at line 204 of file SCR_AvailableActionsDisplay.c.

IsDelayed()

bool SCR_AvailableActionContext::IsDelayed ( )

inlineprotected

returns true if action display is currently counting down twords its delayed fade in or out

Definition at line 252 of file SCR_AvailableActionsDisplay.c.

ResetTimers()

void SCR_AvailableActionContext::ResetTimers ( )

inlineprotected

Reset fade in and fade out timers to their default values.

Definition at line 259 of file SCR_AvailableActionsDisplay.c.

ToString()

string SCR_AvailableActionContext::ToString ( bool forceText = true )

inlineprotected

Definition at line 175 of file SCR_AvailableActionsDisplay.c.

Member Data Documentation

m_aConditions

ref array<ref SCR_AvailableActionCondition> SCR_AvailableActionContext::m_aConditions

protected

Definition at line 158 of file SCR_AvailableActionsDisplay.c.

m_bEnabled

bool SCR_AvailableActionContext::m_bEnabled

protected

Definition at line 149 of file SCR_AvailableActionsDisplay.c.

m_fHideCountdown

float SCR_AvailableActionContext::m_fHideCountdown = m_iTimeForHide

protected

Definition at line 172 of file SCR_AvailableActionsDisplay.c.

m_fShowCountdown

float SCR_AvailableActionContext::m_fShowCountdown = m_iTimeToShow

protected

Definition at line 171 of file SCR_AvailableActionsDisplay.c.

m_iTimeForHide

int SCR_AvailableActionContext::m_iTimeForHide

protected

Definition at line 152 of file SCR_AvailableActionsDisplay.c.

m_iTimeToShow

int SCR_AvailableActionContext::m_iTimeToShow

protected

Definition at line 155 of file SCR_AvailableActionsDisplay.c.

m_sAction

string SCR_AvailableActionContext::m_sAction

protected

Definition at line 164 of file SCR_AvailableActionsDisplay.c.

m_sName

string SCR_AvailableActionContext::m_sName

protected

Definition at line 167 of file SCR_AvailableActionsDisplay.c.

m_sTag

string SCR_AvailableActionContext::m_sTag

protected

Definition at line 161 of file SCR_AvailableActionsDisplay.c.

MARKUP_FORMAT

const string SCR_AvailableActionContext::MARKUP_FORMAT = "<action name=\"%1\"/>"

protected

Definition at line 169 of file SCR_AvailableActionsDisplay.c.

---

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

• scripts/Game/UI/HUD/AvailableActions/SCR_AvailableActionsDisplay.c