SCR_AvailableActionContext Interface Reference

Inheritance diagram for SCR_AvailableActionContext:

Public Member Functions
string	ToString (bool forceText=true)
string	GetActionName ()
string	GetUIName ()
bool	IsAvailable (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
float	m_fShowCountdown = m_iTimeToShow
float	m_fHideCountdown = m_iTimeForHide

Static Protected Attributes
const string	MARKUP_FORMAT = "<action name=\"%1\"/>"

Member Function Documentation

GetActionName()

string SCR_AvailableActionContext.GetActionName

(

)

GetUIName()

string SCR_AvailableActionContext.GetUIName

(

)

Implemented in SCR_HeldItemAvailableActionContext, and SCR_ItemPlacementActionsDisplay.

IsAvailable()

bool SCR_AvailableActionContext.IsAvailable	(	SCR_AvailableActionsConditionData	data,
		float	timeSlice )

Implemented in SCR_HeldItemAvailableActionContext, and SCR_ItemPlacementActionsDisplay.

IsDelayed()

bool SCR_AvailableActionContext.IsDelayed

(

)

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

ResetTimers()

void SCR_AvailableActionContext.ResetTimers

(

)

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

ToString()

string SCR_AvailableActionContext.ToString

(

bool

forceText = true

)

Member Data Documentation

m_aConditions

ref array<ref SCR_AvailableActionCondition> SCR_AvailableActionContext.m_aConditions

protected

m_bEnabled

bool SCR_AvailableActionContext.m_bEnabled

protected

m_fHideCountdown

float SCR_AvailableActionContext.m_fHideCountdown = m_iTimeForHide

protected

m_fShowCountdown

float SCR_AvailableActionContext.m_fShowCountdown = m_iTimeToShow

protected

m_iTimeForHide

int SCR_AvailableActionContext.m_iTimeForHide

protected

m_iTimeToShow

int SCR_AvailableActionContext.m_iTimeToShow

protected

m_sAction

string SCR_AvailableActionContext.m_sAction

protected

m_sName

string SCR_AvailableActionContext.m_sName

protected

m_sTag

string SCR_AvailableActionContext.m_sTag

protected

MARKUP_FORMAT

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

staticprotected

---

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

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