SCR_AvailableActionCondition Class Reference

A single available action condition representation. More...

Inheritance diagram for SCR_AvailableActionCondition:

Protected Member Functions
bool	IsEnabled ()
bool	GetReturnResult (bool desiredResult)
bool	IsAvailable (notnull SCR_AvailableActionsConditionData data)

Protected Attributes
bool	m_bEnabled
bool	m_bNegateCondition

Detailed Description

A single available action condition representation.

Definition at line 3 of file SCR_AvailableActionCondition.c.

Member Function Documentation

GetReturnResult()

bool SCR_AvailableActionCondition::GetReturnResult ( bool desiredResult )

inlineprotected

Based on the state of m_bNegateCondition returns our desired result

Returns

desiredResult if !m_bNegateCondition, !desiredResult if m_bNegateCondition

Definition at line 22 of file SCR_AvailableActionCondition.c.

IsAvailable()

bool SCR_AvailableActionCondition::IsAvailable ( notnull SCR_AvailableActionsConditionData data )

inlineprotected

Override and implement this method in any inherited conditions. Use GetReturnResult prior to returning the value to take m_bNegateCondition into account

Parameters

data

Returns

availability

Definition at line 35 of file SCR_AvailableActionCondition.c.

IsEnabled()

bool SCR_AvailableActionCondition::IsEnabled ( )

inlineprotected

Getter for an enabled flag, disabled conditions are skipped, not evaluated at all

Returns

true if enabled, false otherwise

Definition at line 14 of file SCR_AvailableActionCondition.c.

Member Data Documentation

m_bEnabled

bool SCR_AvailableActionCondition::m_bEnabled

protected

Definition at line 6 of file SCR_AvailableActionCondition.c.

m_bNegateCondition

bool SCR_AvailableActionCondition::m_bNegateCondition

protected

Definition at line 9 of file SCR_AvailableActionCondition.c.

---

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

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