SCR_ScenarioFrameworkActivationConditionBase Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActivationConditionBase:

Public Member Functions
bool	Init (IEntity entity)

Static Public Member Functions
static bool	EvaluateEmptyOrConditions (SCR_EScenarioFrameworkLogicOperators operator, notnull array< ref SCR_ScenarioFrameworkActivationConditionBase > activationConditions, IEntity entity)
	Runs logical operator on activationConditions.
static bool	EvaluateConditions (SCR_EScenarioFrameworkLogicOperators operator, notnull array< ref SCR_ScenarioFrameworkActivationConditionBase > activationConditions, IEntity entity)
	Runs logical operator on activationConditions.
static bool	EvaluateConditionsAND (array< ref SCR_ScenarioFrameworkActivationConditionBase > activationConditions, IEntity entity)
	Runs logical AND on result of activationConditions.
static bool	EvaluateConditionsOR (array< ref SCR_ScenarioFrameworkActivationConditionBase > activationConditions, IEntity entity)
	Runs logical OR on result of activationConditions.
static bool	EvaluateConditionsNAND (array< ref SCR_ScenarioFrameworkActivationConditionBase > activationConditions, IEntity entity)
	Runs logical NAND on result of activationConditions.
static bool	EvaluateConditionsXOR (array< ref SCR_ScenarioFrameworkActivationConditionBase > activationConditions, IEntity entity)
	Array style XOR.

Public Attributes
bool	m_bDebug

Member Function Documentation

EvaluateConditions()

static bool SCR_ScenarioFrameworkActivationConditionBase.EvaluateConditions ( SCR_EScenarioFrameworkLogicOperators  operator, notnull array< ref SCR_ScenarioFrameworkActivationConditionBase >  activationConditions, IEntity  entity  )

static

Runs logical operator on activationConditions.

Operators exit early when appropriate. Each operator impliments its own function and loop for performance.

Parameters

[in]	operator	Operators to apply on whole array. SCR_EScenarioFrameworkLogicOperators.NOT is interpreted as NAND.
[in]	activationConditions	For logical consistency undefined (empty array) is interpreted as false. Therefore most use-cases should use EvaluateEmptyOrConditions`
[in]	entity	LayerBase or trigger that conditions are registered on.

Returns

Delegates to relevent logic funtion.

EvaluateConditionsAND()

static bool SCR_ScenarioFrameworkActivationConditionBase.EvaluateConditionsAND ( array< ref SCR_ScenarioFrameworkActivationConditionBase >  activationConditions, IEntity  entity  )

static

Runs logical AND on result of activationConditions.

Exits early of first failure.

Parameters

[in]	activationConditions	Conditions that succeed or fail. Empty array returns true.
[in]	entity	LayerBase or trigger that conditions are registered on.

Returns

false if activationConditions is empty or if one condition was unsuccessful.

true if all succeed. false if activationConditions is empty.

EvaluateConditionsNAND()

static bool SCR_ScenarioFrameworkActivationConditionBase.EvaluateConditionsNAND ( array< ref SCR_ScenarioFrameworkActivationConditionBase >  activationConditions, IEntity  entity  )

static

Runs logical NAND on result of activationConditions.

At least one condition must be false. Exits early of first failure. Fun fact, you can construct every binary logic gate with only NAND gates.

Parameters

[in]	activationConditions	Conditions that succeed or fail. Empty array returns true.
[in]	entity	LayerBase or trigger that conditions are registered on.

Returns

true if activationConditions is empty or if one condition was unsuccessful.

EvaluateConditionsOR()

static bool SCR_ScenarioFrameworkActivationConditionBase.EvaluateConditionsOR ( array< ref SCR_ScenarioFrameworkActivationConditionBase >  activationConditions, IEntity  entity  )

static

Runs logical OR on result of activationConditions.

Exits early of first success.

Parameters

[in]	activationConditions	Conditions that succeed or fail. Empty array returns true.
[in]	entity	LayerBase or trigger that conditions are registered on.

Returns

true if any succeed. false if activationConditions is empty.

EvaluateConditionsXOR()

static bool SCR_ScenarioFrameworkActivationConditionBase.EvaluateConditionsXOR ( array< ref SCR_ScenarioFrameworkActivationConditionBase >  activationConditions, IEntity  entity  )

static

Array style XOR.

Exactly one condition has to succeed, otherwise false is returned. Exits early on second success.

Parameters

[in]	activationConditions	Conditions that succeed or fail. Empty array returns true.
[in]	entity	LayerBase or trigger that conditions are registered on.

Returns

false if empty or if more than one condition was successful. true if Exactly one condition succeeded.

EvaluateEmptyOrConditions()

static bool SCR_ScenarioFrameworkActivationConditionBase.EvaluateEmptyOrConditions ( SCR_EScenarioFrameworkLogicOperators  operator, notnull array< ref SCR_ScenarioFrameworkActivationConditionBase >  activationConditions, IEntity  entity  )

static

Runs logical operator on activationConditions.

Operators exit early when appropriate. Each operator impliments its own function and loop for performance.

Parameters

[in]	operator	Operators to apply on whole array. SCR_EScenarioFrameworkLogicOperators.NOT is interpreted as NAND.
[in]	activationConditions	Conditions that succeed or fail. Empty array returns true.
[in]	entity	LayerBase or trigger that conditions are registered on.

Returns

If there are no conditions, returns true. Otherwise delegates to relevent logic funtion.

Init()

bool SCR_ScenarioFrameworkActivationConditionBase.Init

(

IEntity

entity

)

Parameters

[in]

entity

Returns

Implemented in SCR_ScenarioFrameworkDayTimeCondition, SCR_ScenarioFrameworkDayTimeHourCondition, SCR_ScenarioFrameworEntitykDamageStateCondition, SCR_ScenarioFrameworkEntityDistanceCondition, SCR_ScenarioFrameworkVariableValueCondition, and SCR_ScenarioFrameworkWeatherCondition.

Member Data Documentation

m_bDebug

bool SCR_ScenarioFrameworkActivationConditionBase.m_bDebug

---

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

• Game/ScenarioFramework/Conditions/SCR_ScenarioFrameworkActivationConditionBase.c