SCR_AvailableActionCondition Interface Reference

A single available action condition representation. More...

Inheritance diagram for SCR_AvailableActionCondition:

Public Member Functions
bool	IsEnabled ()
	Getter for an enabled flag, disabled conditions are skipped, not evaluated at all.
bool	IsAvailable (SCR_AvailableActionsConditionData data)
	Override and implement this method in any inherited conditions.

Protected Member Functions
bool	GetReturnResult (bool desiredResult)
	Based on the state of m_bNegateCondition returns our desired result.

Protected Attributes
bool	m_bEnabled
bool	m_bNegateCondition

Detailed Description

A single available action condition representation.

Member Function Documentation

GetReturnResult()

bool SCR_AvailableActionCondition.GetReturnResult ( bool desiredResult )

protected

Based on the state of m_bNegateCondition returns our desired result.

Returns

desiredResult if !m_bNegateCondition, !desiredResult if m_bNegateCondition

IsAvailable()

bool SCR_AvailableActionCondition.IsAvailable

(

SCR_AvailableActionsConditionData

data

)

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

Implemented in SCR_ActiveVoNActionCondition, SCR_ANDCondition, SCR_CanCharacterLeaveLadderCondition, SCR_CanItemBeInspectedCondition, SCR_CanOperateVehicleDoorCondition, SCR_CanTurnOutCondition, SCR_CharacterBleedingCondition, SCR_CharacterCanFireWeaponCondition, SCR_CharacterCanGetOutCondition, SCR_CharacterFocusModeCondition, SCR_CharacterFreelookCondition, SCR_CharacterHasConsumableItemEquippedCondition, SCR_CharacterHasGadgetCondition, SCR_CharacterHasGadgetInHandCondition, SCR_CharacterHasItemInHandCondition, SCR_CharacterHasLongRadioCondition, SCR_CharacterHasWeaponCondition, SCR_CharacterIsFallingCondition, SCR_CharacterIsGettingInCondition, SCR_CharacterIsGettingOutCondition, SCR_CharacterIsInVehicleCondition, SCR_CharacterIsSwimmingCondition, SCR_CharacterIsUsingItem, SCR_CharacterRadioCountCondition, SCR_CharacterReloadingCondition, SCR_CharacterSprintingCondition, SCR_CharacterStanceCondition, SCR_CharacterWeaponTypeCondition, SCR_CommandMenuOpenCondition, SCR_CommandMenuSelectedCondition, SCR_DaytimeCondition, SCR_DetonatorHasConnectedChargesCondition, SCR_EditorCanEnterLayerActionCondition, SCR_EditorCountOrMoreEntitiesSelectedActionCondition, SCR_EditorFilterActionCondition, SCR_EditorHasLastNotificationLocationActionCondition, SCR_EditorHoveredEntityIsSelectedActionCondition, SCR_EditorIsStateActionCondition, SCR_EditorLessThenCountWaypointsActionCondition, SCR_EditorModeActiveActionCondition, SCR_EditorOpenedActionCondition, SCR_EditorPlaceCharacterAvailableActionCondition, SCR_GadgetSelectionCondition, SCR_HasMultipleMuzzles, SCR_HasMultipleWeaponsCondition, SCR_HasWoundTypeCondition, SCR_HelicopterAutohoverCondition, SCR_HelicopterWheelBrakesCondition, SCR_HoveredEntityHasFlagsActionComponent, SCR_HoveredEntityIsLockedActionComponent, SCR_InventoryAvailableCondition, SCR_IsActionTriggeredCondition, SCR_IsBallisticDataDisplayVisibleCondition, SCR_IsCharacterADSCondition, SCR_IsCharacterConsciousCondition, SCR_IsCharacterInControlCondition, SCR_IsCharacterUsingLRRCondition, SCR_IsCharacterUsingRadioCondition, SCR_IsContextEnabledCondition, SCR_IsUsingMouseAndKeyboardCondition, SCR_IsUsingVariableSightsCondition, SCR_LastUsedInputDevice, SCR_MapCanActivateCondition, SCR_MapCanDragCondition, SCR_MapCanResetRotationCondition, SCR_MapCanRotateCondition, SCR_MedicalItemsCountCondition, SCR_MortarHasChargeConfigsCondition, SCR_MortarHasMoreBallisticDataCondition, SCR_MuzzleTypeCondition, SCR_ORCondition, SCR_RadialMenuActiveActionCondition, SCR_RadialMenuTypeActiveActionCondition, SCR_SelectedEntitiesContainsTypeActionComponent, SCR_SightsHasIlluminationCondition, SCR_VehicleAltitudeAGLCondition, SCR_VehicleBrakeCondition, SCR_VehicleClutchCondition, SCR_VehicleControllerTypeCondition, SCR_VehicleDamageStateCondition, SCR_VehicleDrivingAssistanceCondition, SCR_VehicleEngineOnCondition, SCR_VehicleFuelCondition, SCR_VehicleGearCondition, SCR_VehicleHasAnyGroundContactCondition, SCR_VehicleLightsCondition, SCR_VehiclePersistentBrakeEngagedCondition, SCR_VehicleSpeedCondition, SCR_VehicleThrottleCondition, SCR_VehicleTurboCondition, SCR_VehicleWeaponAmmoCondition, SCR_VONMenuActiveActionCondition, SCR_WeaponAmmoCountCondition, SCR_WeaponBipodCondition, SCR_WeaponChangeSwitchOpticsCondition, SCR_WeaponFiremodeCondition, SCR_WeaponFiremodeCountCondition, SCR_WeaponHasMagazineCondition, SCR_WeaponIsRaisedCondition, SCR_WeaponMagazineCountCondition, SCR_WeaponManipulationCondition, SCR_WeaponMuzzleChamberedCondition, SCR_WeaponQuickSlotAvailableCondition, SCR_WeaponSightHasZeroingCondition, and SCR_WeaponSwitchAvailableCondition.

IsEnabled()

bool SCR_AvailableActionCondition.IsEnabled

(

)

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

Returns

true if enabled, false otherwise

Member Data Documentation

m_bEnabled

bool SCR_AvailableActionCondition.m_bEnabled

protected

m_bNegateCondition

bool SCR_AvailableActionCondition.m_bNegateCondition

protected

---

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

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