SCR_AIGetActionParameters Interface Reference

Base class of node which outputs action parameters to Behavior Tree variables. More...

Inheritance diagram for SCR_AIGetActionParameters:

Public Member Functions
override ENodeResult	EOnTaskSimulate (AIAgent owner, float dt)
Public Member Functions inherited from SCR_AIActionTask
override void	OnEnter (AIAgent owner)

Static Protected Member Functions
static override bool	VisibleInPalette ()

Additional Inherited Members
Static Public Attributes inherited from SCR_AIActionTask
static const string	ENTITY_PORT = "Entity"
static const string	POSITION_PORT = "Position"
static const string	STANCE_PORT = "Stance"
static const string	ROLEINVEHICLE_PORT = "RoleInVehicle"
static const string	REPORTER_PORT = "ReportingAgent"
static const string	USE_VEHICLES_PORT = "UseVehicles"
static const string	DESIREDDISTANCE_PORT = "DesiredDistance"
static const string	TARGET_PORT = "Target"
static const string	TARGETINFO_PORT = "TargetInfo"
static const string	TARGETPOSITION_PORT = "TargetPosition"
static const string	NEXTCOVERPOSITION_PORT = "NextCoverPosition"
static const string	COMPARTMENT_PORT = "Compartment"
static const string	SMARTACTION_PORT = "SmartActionComponent"
static const string	WEAPON_TYPE_PORT = "WeaponType"
static const string	WEAPON_COMP_PORT = "WeaponComponent"
static const string	MAGAZINE_COMP_PORT = "MagazineComponent"
static const string	MAGAZINE_WELL_PORT = "MagazineWell"
static const string	PRIORITY_LEVEL_PORT = "PriorityLevel"
static const string	MUZZLE_ID = "MuzzleID"
static const string	WAYPOINT_PORT = "Waypoint"
static const string	BOARDING_PARAMS_PORT = "BoardingParams"
static const string	DEFEND_DIRECTION_PORT = "DefendDirection"
static const string	DEFEND_LOCATION_PORT = "DefendLocation"
static const string	ANGULAR_RANGE_PORT = "AngularRange"
static const string	WAYPOINT_RELATED_PORT = "WaypointRelated"
static const string	IS_DANGEROUS_PORT = "isDangerous"
static const string	RESET_TIMER_PORT = "ResetTimer"
static const string	TIMEOUT_PORT = "Timeout"
static const string	DELAY_PORT = "Delay"
static const string	REINIT_PORT = "Reinit"
static const string	RADIUS_PORT = "Radius"
static const string	AGENT_SCRIPT_PORT = "AgentScript"
static const string	RELATED_INVOKER_PORT = "RelatedInvoker"
Protected Member Functions inherited from SCR_AIActionTask
SCR_AIActionBase	GetExecutedAction ()
	Returns current action from the utility component.
Protected Attributes inherited from SCR_AIActionTask
SCR_AIBaseUtilityComponent	m_UtilityComp

Detailed Description

Base class of node which outputs action parameters to Behavior Tree variables.

If you need to expose action parameters to a BT, you must create a scripted node class which inherits from SCR_AIGetActionParameters.

The action class must use SCR_BTParam for variables which must be exposed to Behavior Trees.

For example: class SCR_AIGetFlyHelicopterParameters : SCR_AIGetActionParameters { static ref TStringArray s_aVarsOut = (new SCR_AIFlyHelicopterBehavior(null, false)).GetPortNames(); // (1) override TStringArray GetVariablesOut() { return s_aVarsOut; } // protected static override bool VisibleInPalette() { return true; } // (2) };

(1) We need to create an action object once to get port names. We store the resulting array into a static variable. Please ensure that constructor does not call any other code which is inaccessible during script compilation!

(2) Remember to override VisibleInPallete!

Member Function Documentation

EOnTaskSimulate()

override ENodeResult SCR_AIGetActionParameters.EOnTaskSimulate	(	AIAgent	owner,
		float	dt )

Implemented in SCR_AIGetMoveIndividuallyBehaviorParameters.

VisibleInPalette()

static override bool SCR_AIGetActionParameters.VisibleInPalette ( )

staticprotected

Implemented in SCR_AIFireIllumFlareBehaviorParameters, SCR_AIGetAnimateBehaviorParameters, SCR_AIGetAttackBehaviorParameters, SCR_AIGetDefendActivityParameters, SCR_AIGetDefendBehaviorParameters, SCR_AIGetFirePositionBehaviorParameters, SCR_AIGetFollowActivityParameters, SCR_AIGetGetInActivityParameters, SCR_AIGetGetInVehicleBehaviorParameters, SCR_AIGetGetOutActivityParameters, SCR_AIGetHealActivityParameters, SCR_AIGetHealWaitBehaviorParameters, SCR_AIGetInvestigateBehaviorParameters, SCR_AIGetMedicHealBehaviorParameters, SCR_AIGetMoveActivityParameters, SCR_AIGetMoveFromDangerBehaviorParameters, SCR_AIGetMoveFromUnsafeAreaBehaviorParameters, SCR_AIGetMoveIndividuallyBehaviorParameters, SCR_AIGetObserveUnknownFireBehaviorParameters, SCR_AIGetOutVehicleBehaviorParameters, SCR_AIGetPerformActionActivityParameters, SCR_AIGetPerformActionBehaviorParameters, SCR_AIGetPickupInventoryItemsParameters, SCR_AIGetPilotMoveFromIncomingVehicleBehaviorParameters, SCR_AIGetProvideAmmoBehaviorParameters, SCR_AIGetResupplyActivityParameters, SCR_AIGetRetreatFromTargetBehaviorParameters, SCR_AIGetRetreatWhileLookAtBehaviorParameters, SCR_AIGetStaticArtilleryBehaviorParameters, SCR_AIGetSuppressActivityParameters, SCR_AIGetSuppressBehaviorParameters, and SCR_AIGetThrowGrenadeToBehaviorParameters.

---

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

• Game/AI/ScriptedNodes/Behavior/SCR_AIGetActionParameters.c