Name 

Description 

 

CreateQueryFromTacticalSpec 

 

 

GetEntityFromParam 

Fetch entity pointer from script parameter
Fetch entity pointer from script parameter 

 

GetEntityIdFromParam 

Fetch entity ID from script parameter
Fetch entity ID from script parameter 

 

GetGroupSpatialProperties 

 

 

GetSignalExtraData 

 

 

RayWorldIntersectionWrapper 

wrapper, to make it use tick-counter 

 

SetLastOpResult 

This is SetLastOpResult, a member of class CScriptBindAI. 

 

SetPFProperties 

This is the overview for the SetPFProperties method overload. 

 

Name 

Description 

 

AbortAction 

Syntax: AI.AbortAction( userId [, actionId ] )
Aborts execution of an action if actionId is specified or aborts execution of all actions if actionId is nil or 0 

 

AddAggressiveTarget 

Syntax: AI.AddAggressiveTarget( entityId, targetId )
Add the target Id as an aggressive potential target to the entity's list 

 

AddCombatClass 

Creates new combat class
 

 

AddCoverEntity 

This is AddCoverEntity, a member of class CScriptBindAI. 

 

AddFormationPoint 

Syntax: AI.AddFormationPoint(name, sightangle, distance, offset, [unit_class [,distanceAlt, offsetAlt]] )
Adds a follow-type node to a formation descriptor 

 

AddFormationPointFixed 

Syntax: AI.AddFormationPointFixed(name, sightangle, x, y, z [,unit_class])
Adds a node with a fixed offset to a formation descriptor 

 

AddPatternBranch 

Syntax: AI.AddPatternBranch( nodeName, method, branchNode1, branchNode2, ..., branchNodeN )
Creates a branch pattern at the specified node. When the entity has approached the specified node (nodeName), and it is time to choose a new point, the rules defined by this function will be used to select the new point. This function allows to associate multiple target points and an evaluation rule. 

 

AddPatternNode 

Syntax: AI.AddPatternNode( nodeName, offsetx, offsety, offsetz, flags, [parent], [signalValue] )
Adds point to the track pattern. When validating the points test is made from the start position to the end position. Start position is either the pattern origin or in case the parent is provided, the parent position. The end position is either relative offset from the start position or offset from the pattern origin, this is chosen based on the node flag. The offset is clamped to the physical world based on the test method. The points will be evaluated in the same oder they are added to the... more 

 

AddPersonallyHostile 

Syntax: AI.AddPersonallyHostile(entityID, hostileID)
 

 

AgentLookAtPos 

Syntax: AI.AgentLookAtPos(entityId, pos)
Makes the entityId look at certain position 

 

AllowLowerBodyToTurn 

Syntax: AI.LockBodyTurn(entityID, bAllowLowerBodyToTurn) 

 

Animation 

 

 

AssignPathTypeToSOUser 

 

 

AssignPFPropertiesToPathType 

This is the overview for the AssignPFPropertiesToPathType method overload. 

 

AutoDisable 

AutoDisable 

 

BeginGoalPipe 

Syntax: AI.BeginGoalPipe( szPipeName )
Creates a goal pipe and allows to start filling it. 

 

BeginGroup 

Syntax: AI.BeginGroup()
to define group of goals
 

 

BeginTrackPattern 

Syntax: AI.BeginTrackPattern( patternName, flags, validationRadius, [stateTresholdMin], [stateTresholdMax], [globalDeformTreshold], [localDeformTreshold], [exposureMod], [randomRotAng] )
Begins definition of a new track pattern descriptor. The pattern is created bu calling the AI.AddPatternPoint() and AI.AddPatternBranch() functions, and finalised by calling the AI.EndTrackPattern(). 

 

BehaviorEvent 

This is BehaviorEvent, a member of class CScriptBindAI. 

 

BreakEvent 

This is BreakEvent, a member of class CScriptBindAI. 

 

CanFireInStance 

Syntax: AI.CanFireInStance(entityId, stance)
Returns if AI can fire at his target in the given stance at his current position 

 

CanMelee 

Syntax: AI.CanMelee(entityId)
returns 1 if the AI is able to do melee attack. 

 

CanMoveStraightToPoint 

Syntax: AI.CanMoveStraightToPoint(entityId, position)
Returns true if the entity can move to the specified position in a straight line (no multiple segment path necessary) 

 

ChangeFormation 

Syntax: AI.ChangeFormation(entityId, name [,scale] )
Changes the formation descriptor for the current formation of given entity's group (if there is a formation) 

 

ChangeMovementAbility 

Syntax: AI.ChangeMovementAbility( entityId, paramEnum, paramValue )
Changes an enumerated AI movement ability parameter. 

 

ChangeParameter 

Syntax: AI.ChangeParameter( entityId, paramEnum, paramValue )
Changes an enumerated AI parameter. 

 

CheckForFriendlyAgentsAroundPoint 

Syntax: AI.CheckForFriendlyAgentsAroundPoint( entityID, point, radius) 

 

CheckMeleeDamage 

Syntax: AI.CheckMeleeDamage(entityId, targetId, radius, minheight, maxheight, angle)
returns 1 if the AI performing melee is actually hitting target. 

 

CheckVehicleColision 

 

 

ClearAnimationTag 

Syntax: AI.ClearAnimationTag(entityId, tagName) 

 

ClearForReload 

Syntax: AI.ClearForReload( szPipeName )
Clears all goalpipes from the system 

 

ClearMovementContext 

Syntax: AI.ResetMovementContext(entityId)
reset the given entity's movement context 

 

ClearPotentialTargets 

Syntax: AI.ClearPotentialTargets( entityId )
Clears all the potential targets from the AI's perception handler 

 

ClearTempTarget 

Syntax: AI.ClearTempTarget( entityId )
Removes the entity's temporary potential target, so it is no longer considered for target selection 

 

ConstrainPointInsideGenericShape 

Syntax: AI.ConstrainPointInsideGenericShape(position, shapeName[, checkHeight])
Returns the nearest point inside specified shape. 

 

CreateFormation 

Syntax: AI.CreateFormation( name )
Creates a formation descriptor and adds a fixed node at 0,0,0 (owner's node). 

 

CreateGoalPipe 

Syntax: AI.CreateGoalPipe( szPipeName )
Used for warnings about data/script errors 

 

CreateGroupFormation 

Syntax: AI.CreateGroupFormation(entityId, leaderId)
Creates a group formation with leader (or updates leader) 

 

CreateStimulusEvent 

Syntax: AI.CreateStimulusEvent(entityId, targetId, stimulusName, pData)
Creates a target track stimulus event for the entity using the specified data 

 

CreateStimulusEventInRange 

This is CreateStimulusEventInRange, a member of class CScriptBindAI. 

 

CreateTempGenericShapeBox 

Syntax: AI.CreateTempGenericShapeBox(center, radius, height, type)
Creates a temporary box shaped generic shape (will be destroyed upon AIsystem reset). Returns the name of the shape. 

 

DebugReportHitDamage 

Syntax: AI.DebugReportHitDamage(pVictimEntity, pShooterEntity)
Creates a debug report for the hit damage.
DebugReportHitDamage 

 

DestroyAllTPSQueries 

Syntax: AI2.DestroyAllTPSQueries()
Destroys all the tactical point system queries.
 

 

DistanceToGenericShape 

Syntax: AI.DistanceToGenericShape(position, shapeName[, checkHeight])
Returns true if the point is inside the specified shape. 

 

DropTarget 

Syntax: AI.DropTarget( entityId, targetId )
Clears the target from the AI's perception handler 

 

EnableCoverFire 

Syntax: AI.EnableCoverFire(entityId, enable)
enables/disables fire when the FIREMODE_COVER is selected 

 

EnableFire 

Syntax: AI.EnableFire(entityId, enable)
enables/disables fire 

 

EnableUpdateLookTarget 

Syntax: AI.EnableUpdateLookTarget(entityID, bEnable) 

 

EnableWeaponAccessory 

Syntax: AI.EnableWeaponAccessory(entityId, accessory, state)
Enables or disables certain weapon accessory usage. 

 

EndGoalPipe 

Syntax: AI.EndGoalPipe()
Ends creating a goal pipe
 

 

EndGroup 

Syntax: AI.EndGroup()
to define end of group of goals
 

 

EndTrackPattern 

Syntax: AI.EndTrackPattern()
Finalizes the track pattern definition. This function should always called to finalize the pattern. Failing to do so will cause erratic behavior. 

 

Error 

Syntax: AI.Error( szMessage )
Used when we really can't handle some data/situation. The code following this should struggle on so that the original cause (e.g. data) of the problem can be fixed in the editor, but in game this would halt execution 

 

EvalHidespot 

 

 

EvalPeek 

Syntax: AI.EvalPeek(entityId [, bGetOptimalSide])
Evaluates if an AI object can peek from his current position 

 

Event 

 

 

ExecuteAction 

Syntax: AI.ExecuteAction( action, participant1 [, participant2 [, ... , participantN ] ] )
Executes an Action on a set of Participants 

 

FindObjectOfType 

Syntax: AI.FindObjectOfType( entityId, radius, AIObjectType, flags [,returnPosition [,returnDirection]] ) | AI.FindObjectOfType( position, radius, AIObjectType, [,returnPosition [,returnDirection]] )
returns the closest AIObject of a given type around a given entity/position; once an AIObject is found, it's devalued and can't be found again for some seconds (unless specified in flags) 

 

FindStandbySpotInShape 

AI.FindStandbySpotInShape(centerPos, targetPos, anchorType);
FindStandbySpotInShape 

 

FindStandbySpotInSphere 

AI.FindStandbySpotInSphere(centerPos, targetPos, anchorType);
FindStandbySpotInSphere 

 

FreeSignal 

Syntax: AI.FreeSignal( signalType, SignalText, position, radius [, entityID [,signalExtraData]] )
Sends a signal to anyone in a given radius around a position
 

 

GetAIObjectPosition 

Syntax: AI.GetAIObjectPosition( entityId | AIObjectName )
get the given AIObject's position 

 

GetAlertness 

 

 

GetAnchor 

Syntax: AI.GetAnchor( entityId, radius, AIAnchorType, searchType [,returnPosition [,returnDirection]] )
returns the closest Anchor of a given type around a given entity; once an Anchor is found, it's devalued and can't be found again for some seconds (unless specified in flags) 

 

GetAttentionTargetAIType 

Syntax: AI.GetAttentionTargetAIType( entityId )
returns the given entity's attention target AI type (AIOBJECT_*) 

 

GetAttentionTargetDirection 

Syntax: AI.GetAttentionTargetDirection( entityId, returnDir )
returns the given entity's attention target's direction 

 

GetAttentionTargetDistance 

Syntax: AI.GetAttentionTargetDistance( entityId )
returns the given entity's attention target's distance to the entity 

 

GetAttentionTargetEntity 

Syntax: AI.GetAttentionTargetEntity( entityId )
returns the given entity's attention target entity (if it is an entity) or the owner entity of the attention target if it is a dummy object (if there is an owner entity) 

 

GetAttentionTargetOf 

Syntax: AI.GetAttentionTargetOf( entityId )
returns the given entity's attention target 

 

GetAttentionTargetPosition 

Syntax: AI.GetAttentionTargetPosition( entityId, returnPos )
returns the given entity's attention target's position 

 

GetAttentionTargetThreat 

Syntax: AI.GetAttentionTargetThreat( entityID ) 

 

GetAttentionTargetType 

Syntax: AI.GetAttentionTargetType( entityId )
returns the given entity's attention target type (AITARGET_*) 

 

GetAttentionTargetViewDirection 

Syntax: AI.GetAttentionTargetViewDirection( entityId, returnDir )
returns the given entity's attention target's view direction 

 

GetBeaconPosition 

Syntax: AI.GetBeaconPosition( entityId | AIObjectName, returnPos )
get the beacon's position for the given entity/object's group 

 

GetBehaviorBlackBoard 

Syntax: AI.GetBehaviorBlackBoard( entity )
retrieves given AIActor current behaviour's black board (a Lua table) 

 

GetBehaviorVariable 

Syntax: AI.GetBehaviorVariable( entity, variableName, value )
Returns a behavior variable for the specified actor 

 

GetBiasedDirection 

Syntax: AI.GetBiasedDirection(entityId)
Get biased direction of certain point 

 

GetCurrentHideAnchor 

Syntax: AI.GetCurrentHideAnchor( entityId )
Returns the name of the current anchor the entity is using for cover 

 

GetDirectAnchorPos 

Syntax: AI.GetDirectAttackPos(entityId, searchRange, minAttackRange)
Returns a cover point which can be used to directly attack the attention target. Useful for choosing attack position for RPGs and such. Returns nil if no attack point is available. 

 

GetDirLabelToPoint 

Syntax: AI.GetDirLabelToPoint(entityId, point)
Returns a direction label (front=0, back=1, left=2, right_3, above=4, -1=invalid) to the specified point. 

 

GetDistanceAlongPath 

Syntax: AI.GetDistanceAlongPath(entityId1, entityid2)
returns the distance between entity1 and entity2, along entity1's path 

 

GetDistanceToClosestGroupMember 

Syntax: AI.GetDistanceToClosestGroupMember(entityId) 

 

GetEnclosingGenericShapeOfType 

Syntax: AI.GetEnclosingGenericShapeOfType(position, type[, checkHeight])
Returns the name of the first shape that is enclosing the specified point and is of specified type 

 

GetEnclosingSpace 

 

 

GetExtraPriority 

Syntax: AI.GetExtraPriority( enemyEntityId )
get an extra priority value to the entity which is given by enemyEntityId 

 

GetFactionOf 

Syntax: AI.GetFactionOf( entityID ) 

 

GetFlyingVehicleFlockingPos 

 

 

GetFormationLookingPoint 

Syntax: AI.GetFormationLookingPoint(entityId)
Gets the looking point position inside the formation 

 

GetFormationPointClass 

Syntax: AI.AddFormationPoint(name, position )
Adds a follow-type node to a formation descriptor 

 

GetFormationPointPosition 

Syntax: AI.GetFormationPointPosition(entityId, pos)
gets the AI's formation point position 

 

GetFormationPosition 

Syntax: AI.GetFormationPosition(entityId)
Gets the Relative position inside the formation 

 

GetForwardDir 

Attention Target / perception related functions
 

 

GetGroupAlertness 

 

 

GetGroupAveragePosition 

Syntax: AI.GetGroupAveragePosition( entityId, properties, returnPos )
gets the average position of the (leader's) group members 

 

GetGroupCount 

Syntax: AI.GetGroupCount( entityId, flags, type )
returns the given entity's group members count 

 

GetGroupMember 

Syntax: AI.GetGroupMember( entityId|groupId, idx, flags, type)
returns the idx-th entity in the given group 

 

GetGroupOf 

Syntax: AI.GetGroupOf( entityId )
returns the given entity's group id 

 

GetGroupScopeUserCount 

Syntax: AI.GetGroupScopeUserCount(entityID, bAllowLowerBodyToTurn) 

 

GetGroupScriptTable 

Syntax: AI.GetGroupScriptTable( groupID ) 

 

GetGroupTarget 

Syntax: AI.GetGroupTarget( entityId [,bHostileOnly [,bLiveOnly]] )
Returns the most threatening attention target amongst the agents in the given entity's group (see IAgent.h for definition of alert status) 

 

GetGroupTargetCount 

Syntax: AI.GetGroupTargetCount( entityId [,bHostileOnly [,bLiveOnly]] )
Returns the number of attention targets amongst the agents in the given entity's group 

 

GetGroupTargetEntity 

Syntax: AI.GetGroupTargetEntity( groupID ) 

 

GetGroupTargetThreat 

Syntax: AI.GetGroupTargetThreat( groupID ) 

 

GetGroupTargetType 

Syntax: AI.GetGroupTargetType( groupID ) 

 

GetHeliAdvancePoint 

 

 

GetLastUsedSmartObject 

Syntax: AI.GetLastUsedSmartObject( userEntityId )
Returns the last used smart object 

 

GetLeader 

Syntax: AI.GetLeader( groupID | entityID )
returns the leader's name of the given groupID / entity 

 

GetMemoryFireType 

Syntax: AI.GetMemoryFireType(entityId)
Returns how the puppet handles firing at its memory target 

 

GetNavigationType 

Syntax: AI.GetNavigationType(entityId)
returns the navigation type value at the specified entity's position, given the entity navigation properties 

 

GetNearestEntitiesOfType 

Syntax: AI.GetNearestEntitiesOfType( entityId|objectname|position, AIObjectType, maxObjects, returnList [,objectFilter [,radius]] )
returns a list of the closest N entities of a given AIObjkect type associated the found objects are then devalued 

 

GetNearestHidespot 

Syntax: AI.GetNearestHidespot(entityId, rangeMin, rangeMax [, center])
Returns position of a nearest hidepoint within specified range, returns nil if no hidepoint is found. 

 

GetNearestPathOfTypeInRange 

Syntax: AI.GetNearestPathOfTypeInRange(entityId, pos, range, type [, devalue, useStartNode])
Queries a nearest path of specified type. The type uses same types as anchors and is specified in the path properties. The function will only return paths that match the requesters (entityId) navigation caps. The nav type is also specified in the path properties. 

 

GetNearestPointOnPath 

Syntax: AI.GetNearestPointOnPath( entityId, pathname, vPos )
returns a nearest point on the path from vPos 

 

GetObjectBlackBoard 

Syntax: AI.GetObjectBlackBoard( entity )
retrieves given object's black board (a Lua table) 

 

GetObjectRadius 

Syntax: AI.GetObjectRadius(entityId)
Returns the radius of specified AI object. 

 

GetParameter 

Syntax: AI.GetParameter( entityId, paramEnum )
Changes an enumerated AI parameter. 

 

GetPathLoop 

Syntax: AI.GetPathSegNoOnPath( entityId, pathname )
returns true if the path is looped 

 

GetPathSegNoOnPath 

Syntax: AI.GetPathSegNoOnPath( entityId, pathname, vPos )
returns segment ratio ( 0.0 start point 100.0 end point ) 

 

GetPeakThreatLevel 

Syntax: AI.GetPeakThreatLevel( entityID ) 

 

GetPeakThreatType 

Syntax: AI.GetPeakThreatType( entityID ) 

 

GetPointOnPathBySegNo 

Syntax: AI.GetPathSegNoOnPath( entityId, pathname, segNo )
returns point by segment ratio ( 0.0 start point 100.0 end point ) 

 

GetPosturePriority 

Syntax: AI.GetPosturePriority(entityId, postureName)
Set the given entity's posture priority 

 

GetPotentialTargetCount 

Syntax: AI.GetPotentialTargetCount( entityID )
Retrieves the number of potential targets for an entity from a specified factions. 

 

GetPotentialTargetCountFromFaction 

Syntax: AI.GetPotentialTargetCountFromFaction( entityID, name )
Retrieves the number of potential targets for an entity from a specified factions. 

 

GetPredictedPosAlongPath 

Syntax: AI.GetPredictedPosAlongPath( entityId, time, retPos )
Gets the agent predicted position along his path at a given time 

 

GetPreviousBehaviorName 

Syntax: AI.GetPreviousBehaviorName( entityID ) 

 

GetPreviousPeakThreatLevel 

Syntax: AI.GetPreviousPeakThreatLevel( entityID ) 

 

GetPreviousPeakThreatType 

Syntax: AI.GetPreviousPeakThreatType( entityID ) 

 

GetProbableTargetPosition 

Syntax: AI.GetProbableTargetPosition(entityId)
Returns the probable target position of the AI. 

 

GetReactionOf 

This is GetReactionOf, a member of class CScriptBindAI. 

 

GetRefPointDirection 

Syntax: AI.GetRefPointDirection(entityId)
Get the entity's reference point direction 

 

GetRefPointPosition 

Syntax: AI.GetRefPointPosition(entityId)
Get the entity's reference point World position 

 

GetRefShapeName 

Syntax: AI.GetRefShapeName(entityId)
Returns the reference shape name. 

 

GetSmartObjectHelper 

Syntax: AI.GetSmartObjectHelper( entityId, className, helperName )
Returns table with position and direction vector of given SO helper 

 

GetSoundPerceptionDescriptor 

Syntax: AI.GetSoundPerceptionDescriptor(entityId, soundType, descriptorTable)
Fills descriptorTable with info about how perception works for the entity dealing with soundType 

 

GetStance 

Syntax: AI.GetStance(entityId)
get the given entity's stance 

 

GetSubTypeOf 

Syntax: AI.GetSubTypeOf( entityId )
returns the given entity's sub type 

 

GetTacticalPoints 

Syntax: AI.GetTacticalPoints( entityId, tacPointSpec, point )
Get a point matching a description, related to an entity. Format of a point is: { x,y,z } 

 

GetTargetSubType 

Syntax: AI.GetTargetSubType(entityId)
Returns the subtype of current entity's attention target 

 

GetTargetType 

Syntax: AI.GetTargetType(entityId)
Returns the type of current entity's attention target (memory, human, none etc) 

 

GetTotalLengthOfPath 

Syntax: AI.GetTotalLengthOfPath( entityId, pathname )
returns a total length of the path 

 

GetTypeOf 

Syntax: AI.GetTypeOf( entityId )
returns the given entity's type 

 

GetUnitCount 

Syntax: AI.GetUnitCount( entityId, unitProperties )
Gets the number of units the leader knows about. The leader will be found based on the group id of the entity. 

 

GetUnitInRank 

Syntax: AI.GetUnitInRank( groupID [,rank] )
Returns the entity in the group id in the given rank position, or the highest if rank == nil or rank <=0 the rank is specified in entity.Properties.nRank; 

 

GoTo 

Syntax: AI.GoTo(entityId, vDestination)
This function is intended to allow AI Actor (the entity) go to the specified destination 

 

Hostile 

Syntax: AI.Hostile( entityId, entity2Id|AIObjectName )
returns true if the two entities are hostile 

 

IgnoreCurrentHideObject 

Syntax: AI.IgnoreCurrentHideObject( entityId )
Marks the current hideobject unreachable (will be omitted from future hidespot selections). 

 

IntersectsForbidden 

Syntax: AI.IsPointInFlightRegion(start, end)
check if the line is in a Forbidden Region 

 

InvalidateHidespot 

 

 

IsAgentInAgentFOV 

Syntax: AI.IsAgentInAgentFOV(entityId, entityId2)
Check if the entity2 is within the entity FOV 

 

IsAgentInTargetFOV 

Syntax: AI.IsAgentInTargetFOV(entityId, fov)
Checks if the entity is in the FOV of the attention target. 

 

IsAimReady 

Syntax: AI.IsAimReady(entityIdHandle) 

 

IsCoverCompromised 

Syntax: AI.IsCoverCompromised(entityId) 

 

IsEnabled 

Syntax: AI.IsEnabled( entityId )
Returns true if entity's AI is enabled 

 

IsFireEnabled 

Syntax: AI.IsFireEnabled(entityId)
checks if ai is allowed to fire or not 

 

IsGoalPipe 

Syntax: AI.IsGoalPipe( szPipeName )
Checks is a goalpipe of certain name exists already, returns true if pipe exists. 

 

IsInCover 

Syntax: AI.IsInCover(entityId) 

 

IsLowHealthPauseActive 

Syntax: AI.IsLowHealthPauseActive( entityID ) 

 

IsLowOnAmmo 

Syntax: AI.IsLowOnAmmo(entityId) 

 

IsMoving 

Syntax: AI.IsMoving(entityId)
Returns true if the agent desires to move. 

 

IsMovingInCover 

Syntax: AI.IsMovingInCover(entityId) 

 

IsMovingToCover 

Syntax: AI.IsMovingToCover(entityId) 

 

IsOutOfAmmo 

Syntax: AI.IsOutOfAmmo(entityId) 

 

IsPersonallyHostile 

Syntax: AI.IsPersonallyHostile(entityID, hostileID) 

 

IsPointInFlightRegion 

Syntax: AI.IsPointInFlightRegion(point)
check if the point is in the Flight Region 

 

IsPointInsideGenericShape 

Syntax: AI.IsPointInsideGenericShape(position, shapeName[, checkHeight])
Returns true if the point is inside the specified shape. 

 

IsPointInWaterRegion 

Syntax: AI.IsPointInFlightRegion(point)
check if the point is in the Flight Region 

 

IsPunchableObjectValid 

Syntax: AI.IsPunchableObjectValid(userId, objectId, origPos)
Checks if a punchable object is valid.
 

 

IsTakingCover 

Syntax: AI.IsTakingCover(entityId, [distanceThreshold]) 

 

LoadBehaviors 

Syntax: AI.LoadBehaviors( folderName, extension, globalEnv) 

 

LoadCharacters 

Syntax: AI.LoadCharacters(folderName, tbl) 

 

LoadGoalPipes 

XML support for goal pipes ///////////////////////////////////////////////////////////////////////////////////////////////////////  

 

LogComment 

Syntax: AI.LogComment( szMessage )
Used to indicate info that would be useful for debugging, but there's too much of it for it to be enabled all the time 

 

LogEvent 

Syntax: AI.LogEvent( szMessage )
Used to indicate event-driven info that would be useful for debugging (may occur on a per-frame or even per-AI-update basis) 

 

LogProgress 

Syntax: AI.LogProgress( szMessage )
Used to indicate "progress markers" - e.g. during loading 

 

MeleePunchableObject 

Syntax: AI.MeleePunchableObject(entityId, objectId, origPos) 

 

ModifySmartObjectStates 

Syntax: AI.ModifySmartObjectStates( entityId, listStates )
Adds/Removes smart object states of a given entity 

 

NotifyGroup 

This is NotifyGroup, a member of class CScriptBindAI. 

 

NotifyReinfDone 

 

 

NotifySurpriseEntityAction 

NotifySurpriseEntityAction 

 

ParseTables 

Syntax: AI.ParseTables( firstTable,parseMovementAbility,pH,aiParams,updateAlways ) 

 

PlayCommunication 

Syntax: AI.PlayCommunication(entityId, commName, channelName[, targetId] [, targetPos])
Plays communication on the AI agent.
Plays communication on the AI agent. 

 

PlayReadabilitySound 

Syntax: AI.PlayReadabilitySound(entityId, soundName)
Plays readability sound on the AI agent. This call does not do any filtering like playing readability using signals. 

 

ProcessBalancedDamage 

Syntax: AI.ProcessBalancedDamage(pShooterEntity, pTargetEntity, damage, damageType)
Processes balanced damage. 

 

PushGoal 

Syntax: AI.PushGoal( szPipeName, goalName, blocking [,{params}] )
Used for warnings about data/script errors 

 

PushLabel 

Syntax: AI.PushLabel( szPipeName, szLabelName )
Used in combination with "branch" goal operation to identify jump destination 

 

QueueBubbleMessage 

Syntax: AI.QueueBubbleMessage(entityID, message, flags) 

 

RecComment 

Syntax: AI.RecComment( szMessage )
Record comment with AIRecorder. 

 

RegisterDamageRegion 

Syntax: AI.RegisterDamageRegion(entityId, radius)
Register a spherical region that causes damage (so should be avoided in pathfinding). Owner entity position is used as region center. Can be called multiple times, will just move update region position 

 

RegisterInterestedActor 

Syntax: AI.RegisterInterestedActor(entityId, fInterestFilter, fAngleInDegrees)
Registers the interested actor with the interest system Any errors go to error log 

 

RegisterInterestingEntity 

Syntax: AI.RegisterInterestingEntity(entityId, baseInterest, category, aiAction)
Registers the entity with the interest system Any errors go to error log 

 

RegisterTacticalPointQuery 

Syntax: AI.RegisterTacticalPointQuery( querySpecTable )
Get a query ID for the given tactical point query 

 

RegisterTargetTrack 

Syntax: AI.RegisterTargetTrack(entityId, configuration, targetLimit, classThreat)
Registers the AI object to use the given target track configuration for target selection 

 

Release 

This is Release, a member of class CScriptBindAI. 

 

RemoveCoverEntity 

This is RemoveCoverEntity, a member of class CScriptBindAI. 

 

RemovePersonallyHostile 

Syntax: AI.RemovePersonallyHostile(entityID, hostileID) 

 

RequestAttack 

Syntax: AI.RequestAttack( entityId, unitProperties, attackTypeList [,duration] )
in a group with leader, the entity requests for a group attack behavior against the enemy The Cleader later will possibly create an attack leader action (CLeaderAction_Attack_*) 

 

RequestToStopMovement 

Syntax: AI.RequestToStopMovement(entityId) 

 

ResetAgentLookAtPos 

Syntax: AI.ResetAgentLookAtPos(entityId)
Makes the entityId resets a previous call to AgentLookAtPos() 

 

ResetAgentState 

Syntax: AI.ResetAgentState(entityId,stateLabel)
Resets a particular aspect of the agent's state, such as "lean" Intended to keep these hacky concepts together. 

 

ResetParameters 

Syntax: AI.ResetParameters( entityId, bProcessMovement, PropertiesTable, PropertiesInstanceTable )
Resets all the AI parameters 

 

ResetPersonallyHostiles 

Syntax: AI.ResetPersonallyHostiles(entityID, hostileID) 

 

RunStartupScript 

RunStartupScript 

 

ScaleFormation 

Syntax: AI.ScaleFormation(entityId, scale)
changes the scale factor of the given entity's formation (if there is) 

 

SequenceBehaviorReady 

Syntax: AI.SequenceBehaviorReady(entityId) 

 

SequenceInterruptibleBehaviorLeft 

Syntax: AI.SequenceInterruptibleBehaviorLeft(entityId) 

 

SequenceNonInterruptibleBehaviorLeft 

Syntax: AI.SequenceNonInterruptibleBehaviorLeft(entityId) 

 

SetAdjustPath 

 

 

SetAlarmed 

Syntax: AI.SetAlarmed( entityId )
This function sets the entity to be "perception alarmed" 

 

SetAnimationTag 

Syntax: AI.SetAnimationTag(entityId, tagName) 

 

SetAssesmentMultiplier 

Syntax: AI.SetAssesmentMultiplier(AIObjectType, multiplier)
set the assesment multiplier factor for the given AIObject type 

 

SetAttentiontarget 

Syntax: AI.SetAttentiontarget(entityId, targetId)
Set a new attention target 

 

SetBeaconPosition 

Syntax: AI.SetBeaconPosition( entityId | AIObjectName, pos )
Set the beacon's position for the given entity/object's group 

 

SetBehaviorTreeEvaluationEnabled 

Syntax: AI.SetBehaviorTreeEvaluationEnabled(entityID, enable) 

 

SetBehaviorVariable 

Syntax: AI.SetBehaviorVariable( entity, variableName, value )
Sets a behaviour variable for the specified actor 

 

SetCharacter 

Syntax: AI.SetCharacter(entityId, newCharater)
Sets the AI character of the entity. 

 

SetCollisionAvoidanceRadiusIncrement 

Syntax: AI.SetCollisionAvoidanceRadiusIncrement(entityId, radius) 

 

SetContinuousMotion 

Syntax: AI.SetContinuousMotion( entityID, continuousMotion ) 

 

SetCoverCompromised 

Syntax: AI.SetCoverCompromised(entityId)
 

 

SetEntitySpeedRange 

Syntax: AI.SetEntitySpeedRange( userEntityId, urgency, defaultSpeed, minSpeed, maxSpeed, stance = all)
This function allows the user to override the entity's speed range for the given urgency 

 

SetExtraPriority 

Syntax: AI.SetExtraPriority( enemyEntityId, increment )
Set a extra priority value to the entity which is given by enemyEntityId 

 

SetFactionOf 

Syntax: AI.SetFactionOf( entityID, factionName )
Make the specified entity a member of the named faction. 

 

SetFactionThreatMultiplier 

Syntax: AI.SetFactionThreatMultiplier(nSpecies, multiplier)
set the threat multiplier factor for the given species (if 0, species is not hostile to any other) 

 

SetFireMode 

Syntax: AI.SetFireMode(entityId, mode)
immediately sets firemode 

 

SetForcedNavigation 

 

 

SetFormationAngleThreshold 

Syntax: AI.SetFormationAngleThreshold(entityId, fAngleThreshold )
Sets the Relative position inside the formation 

 

SetFormationLookingPoint 

Syntax: AI.SetFormationLookingPoint(entityId, v3RelativePosition )
Sets the Relative looking point position inside the formation 

 

SetFormationPosition 

Syntax: AI.SetFormationPosition(entityId, v2RelativePosition )
Sets the Relative position inside the formation 

 

SetFormationUpdate 

Syntax: AI.SetFormationUpdate(entityId, update)
changes the update flag of the given entity's formation (if there is) - the formation is no more updated if the flag is false 

 

SetFormationUpdateSight 

Syntax: AI.SetFormationUpdateSight(entityId, range, minTime, maxTime )
sets a random angle rotation for the given entity's formation sight directions 

 

SetIgnorant 

Syntax: AI.SetIgnorant( entityId, ignorant )
makes an AI ignore system signals, visual stimuli and sound stimuli 

 

SetInCover 

Syntax: AI.SetInCover(entityId, inCover) 

 

SetLeader 

Syntax: AI.SetLeader( entityID )
Set the given entity as Leader (associating a CLeader object to it and creating it if it doesn't exist) Only one leader can be set per group 

 

SetMemoryFireType 

Syntax: AI.SetMemoryFireType(entityId, type)
Sets how the puppet handles firing at its memory target 

 

SetMovementContext 

Syntax: AI.SetMovementContext(entityId, context)
set the given entity's movement context 

 

SetPathAttributeToFollow 

Syntax: AI.SetPathAttributeToFollow(entityId, flag)
Set the attribute of the path to be used in 'followpath' goal operation. 

 

SetPathToFollow 

Syntax: AI.SetPathToFollow(entityId, pathName)
Set the name of the path to be used in 'followpath' goal operation. 

 

SetPFBlockerRadius 

Syntax: AI.SetPFBlockerRadius(entityId, blocker, radius)
 

 

SetPointListToFollow 

Syntax: AI.SetPointListToFollow(entityId, pointlist, howmanypoints, bspline [, navtype])
Set a point list for followpath goal op 

 

SetPosturePriority 

Syntax: AI.SetPosturePriority(entityId, postureName, priority)
Set the given entity's posture priority 

 

SetPostures 

Syntax: AI.SetPostures(entityId, postures)
Set the given entity's postures 

 

SetReactionOf 

This is SetReactionOf, a member of class CScriptBindAI. 

 

SetRefPointAtDefensePos 

Syntax: AI.SetRefPointAtDefensePos(entityId, point2defend, distance)
Set the entity refpoint position in an intermediate distance between the entity's att target and the given point 

 

SetRefPointDirection 

Syntax: AI.SetRefPointDirection( vRefPointDir )
Sets the reference point's World position of an entity 

 

SetRefPointPosition 

Syntax: AI.SetRefPointPosition(entityId, vRefPointPos)
Sets the reference point's World position of an entity 

 

SetRefPointRadius 

Syntax: AI.SetRefPointRadius(entityId, radius)
Sets the reference point's radius. 

 

SetRefpointToAnchor 

Syntax: AI.SetRefpointToAnchor(entityId, rangeMin, rangeMax, findType, findMethod)
Sets a reference point to an anchor.
 

 

SetRefPointToGrenadeAvoidTarget 

 

 

SetRefpointToPunchableObject 

Syntax: AI.SetRefpointToPunchableObject(entityId, range)
Sets the reference point to the punchable object.
 

 

SetRefShapeName 

Syntax: AI.SetRefShapeName(entityId, name)
Sets the reference shape name. 

 

SetSmartObjectState 

Syntax: AI.SetSmartObjectState( entityId, stateName )
Sets only one single smart object state replacing all other states 

 

SetSoundPerceptionDescriptor 

Syntax: AI.SetSoundPerceptionDescriptor(entityId, soundType, descriptorTable)
Sets data on how perception works for the entity dealing with soundType 

 

SetSpeed 

Syntax: AI.SetSpeed(entityId, urgency)
This function allows the user to override the entity's current speed (urgency) 

 

SetStance 

Syntax: AI.SetStance(entityId, stance)
set the given entity's stance 

 

SetTargetTrackClassThreat 

Syntax: AI.SetTargetTrackClassThreat(entityId, classThreat)
Sets the class threat for the entity for target track usage 

 

SetTempTargetPriority 

Syntax: AI.SetTempTargetPriority( entityId, priority )
Set the selection priority of the temp target over other potential targets 

 

SetTerritoryShapeName 

Syntax: AI.SetTerritoryShapeName(entityId, shapeName)
Sets the territory of the AI Actor. 

 

SetUnitProperties 

Syntax: AI.SetUnitProperties( entityId, unitProperties )
Sets the leader knowledge about the units combat capabilities. The leader will be found based on the group id of the entity. 

 

SetUseSecondaryVehicleWeapon 

Syntax: AI.SetUseSecondaryVehicleWeapon(entityId, bUseSecondary)
Sets if the AI should use the secondary weapon when firing from a vehicle gunner seat if possible 

 

SetVehicleStickTarget 

 

 

Signal 

Syntax: AI.Signal(signalFilter, signalType, SignalText, senderId [, signalExtraData] )
Sends a signal to an entity or a group of entities 

 

SmartObjectEvent 

Syntax: AI.SmartObjectEvent( actionName, userEntityId, objectEntityId [, vRefPoint] )
Executes a smart action 

 

SoundEvent 

Syntax: AI.SoundEvent(position, radius, threat, interest, entityId)
Generates a sound event in the AI system with the given parameters. 

 

StopCommunication 

Syntax: AI.StopCommunication(playID)
Stops given communication.
Stops given communication. 

 

ThrowGrenade 

Syntax: AI.ThrowGrenade(entityId, grenadeType, regTargetType)
throws a specified grenade at target type without interrupting fire mode 

 

TriggerCurrentTargetTrackPulse 

This is TriggerCurrentTargetTrackPulse, a member of class CScriptBindAI. 

 

UnregisterInterestedActor 

Syntax: AI.UnregisterInterestedActor(entityId)
Unregisters the entity with the interest system Any errors go to error log 

 

UnregisterInterestingEntity 

Syntax: AI.UnregisterInterestingEntity(entityId)
Unregisters the entity with the interest system Any errors go to error log 

 

UnregisterTargetTrack 

Syntax: AI.UnregisterTargetTrack(entityId)
Unregisters the AI object with the target track manager 

 

UpdateGlobalPerceptionScale 

Syntax: AI.UpdateGlobalPerceptionScale(visualScale, audioScale, [filterType], [faction]) 

 

UpdateTempTarget 

Syntax: AI.UpdateTempTarget( entityId, vPos )
Updates the entity's temporary potential target to the given position 

 

UpTargetPriority 

Syntax: AI.UpTargetPriority( entityId, targetId, increment )
modifies the current entity's target priority for the given target if the given target is among the entity's target list 

 

VisualEvent 

Syntax: AI.VisualEvent(entityId, targetId)
Generates a visual event in the AI system with the given parameters. 

 

Warning 

Syntax: AI.Warning( szMessage )
Used for warnings about data/script errors