Skip to end of metadata
Go to start of metadata

LogProgress

Used to indicate "progress markers"">e.g. during loading.</description> <param name="szMessage">message line to be displayed in log

Syntax
AI.LogProgress( szMessage )

LogEvent

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

Syntax
AI.LogEvent( szMessage )
ParameterDescription
szMessagemessage line to be displayed in log

LogComment

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.

Syntax
AI.LogComment( szMessage )
ParameterDescription
szMessagemessage line to be displayed in log

Warning

Used for warnings about data/script errors.

Syntax
AI.Warning( szMessage )
ParameterDescription
szMessagemessage line to be displayed in log

Error

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.

Syntax
AI.Error( szMessage )
ParameterDescription
szMessagemessage line to be displayed in log

RecComment

Record comment with AIRecorder.

Syntax
AI.RecComment( szMessage )
ParameterDescription
szMessagemessage line to be displayed in recorder view

ResetParameters

Resets all the AI parameters.

Syntax
AI.ResetParameters( entityId, bProcessMovement, PropertiesTable, PropertiesInstanceTable )
ParameterDescription
entityIdentity id
bProcessMovementreset movement data as well
PropertiesTableLua table containing the entity properties like groupid, sightrange, sound range etc (editable in editor, usually defined as "Properties")
PropertiesInstanceTableanother properties table, same as PropertiesTable (editable in editor, usually defined as "PropertiesInstance")

ChangeParameter

Syntax
AI.ChangeParameter( entityId, paramEnum, paramValue )
ParameterDescription
paramValuenew parameter value, see above for type and meaning.

IsEnabled

Returns true if entity's AI is enabled.

Syntax
AI.IsEnabled( entityId )
ParameterDescription
entityIdentity id

GetTypeOf

returns the given entity's type.

Syntax
AI.GetTypeOf( entityId )
Returns: type of given entity (as defined in IAgent.h)
ParameterDescription
entityIdAI's entity id

GetSubTypeOf

returns the given entity's sub type.

Syntax
AI.GetSubTypeOf( entityId )
Returns: sub type of given entity (as defined in IAgent.h).
ParameterDescription
entityIdAI's entity id

GetParameter

Changes an enumerated AI parameter.

Syntax
AI.GetParameter( entityId, paramEnum )
Returns: parameter value
ParameterDescription
entityIdentity id
paramEnumindex of the parameter to get, see AI.ChangeParameter() for complete list

ChangeMovementAbility

Changes an enumerated AI movement ability parameter.

Syntax
AI.ChangeMovementAbility( entityId, paramEnum, paramValue )
ParameterDescription
entityIdentity id
paramEnumthe parameter to change, should be one of the following: AIMOVEABILITY_OPTIMALFLIGHTHEIGHT - optimal flight height while finding path (meters). AIMOVEABILITY_MINFLIGHTHEIGHT - minimum flight height while finding path (meters). AIMOVEABILITY_MAXFLIGHTHEIGHT - maximum flight height while finding path (meters).
paramValuenew parameter value, see above for type and meaning.

ExecuteAction

Executes an Action on a set of Participants.

Syntax
AI.ExecuteAction( action, participant1 [, participant2 [, ... , participantN ] ] )
ParameterDescription
actionSmart Object Action name or id
participant1entity id of the first Participant in the Action
(optional) participant2..Nentity ids of other participants

AbortAction

Aborts execution of an action if actionId is specified, or aborts execution of all actions if actionId is nil or 0

Syntax
AI.AbortAction( userId [, actionId ] )
ParameterDescription
userIdentity id of the user which AI action is aborted
actionId (optional)id of action to be aborted or 0 (or nil) to abort all actions on specified entity

SetSmartObjectState

Sets only one single smart object state replacing all other states.

Syntax
AI.SetSmartObjectState( entityId, stateName )
ParameterDescription
entityIdentity id
stateNamename of the new state (i.e. "Idle")

ModifySmartObjectStates

Adds/Removes smart object states of a given entity.

Syntax
AI.ModifySmartObjectStates( entityId, listStates )
ParameterDescription
entityIdentity id
listStatesnames of the states to be added and removed (i.e. "Closed, Locked">Open, Unlocked, Busy")

SmartObjectEvent

Executes a smart action.

Syntax
AI.SmartObjectEvent( actionName, userEntityId, objectEntityId [, vRefPoint] )
Returns: 0 if smart object rule wasn't found or a non-zero unique id of the goal pipe inserted to execute the action.
ParameterDescription
actionNamesmart action name
usedEntityIdentity id of the user who needs to execute the smart action or a nil if user is unknown
objectEntityIdentity id of the object on which the smart action needs to be executed or a nil if objects is unknown
vRefPoint(optional) point to be used instead of user's attention target position

GetLastUsedSmartObject

Returns the last used smart object.

Syntax
AI.GetLastUsedSmartObject( userEntityId )
Returns: nil if there's no last used smart object (or if an error has occurred) or the script table of the entity which is the last used smart object
ParameterDescription
usedEntityIdentity id of the user for which its last used smart object is needed

CreateGoalPipe

Used for warnings about data/script errors.

Syntax
AI.CreateGoalPipe( szPipeName )
ParameterDescription
szPipeNamegoal pipe name

BeginGoalPipe

Creates a goal pipe and allows to start filling it.

Syntax
AI.BeginGoalPipe( szPipeName )
ParameterDescription
szPipeNamegoal pipe name

EndGoalPipe

Ends creating a goal pipe.

Syntax
AI.EndGoalPipe()

BeginGroup

to define group of goals.

Syntax
AI.BeginGroup()

EndGroup

Defines the end of a group of goals.

Syntax
AI.EndGroup()

PushGoal

Used for warnings about data/script errors. <param name="until the goal has finished) 0: not blocking, 1: blocking</param> <param name="(optional) params">set of parameters depending on the goal selected; see the AI Manual for a complete list of the parameters for each goal

Syntax
AI.PushGoal( szPipeName, goalName, blocking [,{params}] )
ParameterDescription
szPipeNamegoal pipe name
szGoalNamegoal name - see AI Manual for a complete list of goals
blockingused to mark the goal as blocking (goal pipe execution will stop here

PushLabel

Used in combination with "branch" goal operation to identify jump destination.

Syntax
AI.PushLabel( szPipeName, szLabelName )
ParameterDescription
szPipeNamegoalpipe name
szLabelNamelabel name

IsGoalPipe

Checks is a goalpipe of certain name exists already, returns true if pipe exists.

Syntax
AI.IsGoalPipe( szPipeName )
ParameterDescription
szPipeNamegoalpipe name

ClearForReload

Clears all goalpipes from the system.

Syntax
AI.ClearForReload( szPipeName )

Signal

10: signal is added in the sender's signal queue even if another signal with same text is present (normally it's not) <param name="signalText: signal text which will be processed by the receivers (in a Lua callback with the same name as the text, or directly by the CAIObject)</param> <param name="(optional) signalExtraData: lua table which can be used to send extra data. It can contains the following values: point: a vector in format {x,y,z} point2: a vector in format {x,y,z} ObjectName: a string id: an entity id fValue: a float value iValue: an integer value iValue2: a second integer value

Syntax
AI.Signal(signalFilter, signalType, SignalText, senderId [, signalExtraData] )

FreeSignal

Sends a signal to anyone in a given radius around a position.

Syntax
AI.FreeSignal( signalType, SignalText, position, radius [, entityID [,signalExtraData]] )
ParameterDescription
signalTypesee AI.Signal
signalTextSee AI.Signal
positioncenter position {x,y,z}around which the signal is sent
radiusradius inside which the signal is sent
(optional) entityIDsignal is NOT sent to entities which groupID is same as the entity's one
(optional) signalExtraDataSee AI.Signal

SetIgnorant

makes an AI ignore system signals, visual stimuli and sound stimuli.

Syntax
AI.SetIgnorant( entityId, ignorant )
ParameterDescription
entityIdAI's entity id
ignorant0: not ignorant, 1: ignorant

GetGroupCount

returns the given entity's group members count.

Syntax
AI.GetGroupCount( entityId, flags, type )
Returns: group members count
ParameterDescription
entityIdAI's entity id or groupId - AI's group id
flagscombination of following flags: GROUP_ALL - Returns all agents in the group (default). GROUP_ENABLED - Returns only the count of enabled agents (exclusive with all). GROUP_MAX - Returns the maximum number of agents during the game (can be combined with all or enabled).
typeallows to filter to return only specific AI objects by type (cannot be used in together with GROUP_MAX flag).

GetGroupMember

returns the idx-th entity in the given group.

Syntax
AI.GetGroupMember( entityId|groupId, idx, flags, type)
Returns: script handler of idx-th entity (null if idx is out of range)
ParameterDescription
entityId|groupIdAI's entity id \ group id
idxindex (1..N)
flagscombination of following flags: GROUP_ALL - Returns all agents in the group (default). GROUP_ENABLED - Returns only the count of enabled agents (exclusive with all).
typeallows to filter to return only specific AI objects by type (cannot be used in together with GROUP_MAX flag).

GetGroupOf

returns the given entity's group id.

Syntax
AI.GetGroupOf( entityId )
Returns: group id of given entity
ParameterDescription
entityIdAI's entity id

GetFactionOf

Syntax
AI.GetFactionOf( entityID )
Returns: The faction of the specified entity.

SetFactionOf

Make the specified entity a member of the named faction.

Syntax
AI.SetFactionOf( entityID, factionName )

GetUnitInRank

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

Syntax
AI.GetUnitInRank( groupID [,rank] )
Returns: entity script table of the ranked unit
ParameterDescription
rankrank position (the highest (1) if rank == nil or rank <=0)

SetUnitProperties

Sets the leader knowledge about the units combat capabilities. The leader will be found based on the group id of the entity.

Syntax
AI.SetUnitProperties( entityId, unitProperties )
ParameterDescription
entityIdAI's entity id
unitPropertiesbinary mask of unit properties type for which the attack is requested (in the form of UPR_* + UPR* i.e. UPR_COMBAT_GROUND + UPR_COMBAT_FLIGHT) see IAgent.h for definition of unit properties UPR_*

GetUnitCount

Gets the number of units the leader knows about. The leader will be found based on the group id of the entity.

Syntax
AI.GetUnitCount( entityId, unitProperties )
ParameterDescription
entityIdAI's entity id
unitPropertiesbinary mask of the returned unit properties type (in the form of UPR_* + UPR* i.e. UPR_COMBAT_GROUND + UPR_COMBAT_FLIGHT) see IAgent.h for definition of unit properties UPR_*

Hostile

returns true if the two entities are hostile.

Syntax
AI.Hostile( entityId, entity2Id|AIObjectName )
Returns: true if the entities are hostile
ParameterDescription
entityId1st AI's entity id
entity2Id | AIObjectName2nd AI's entity id | 2nd AIobject's name

GetLeader

Syntax
AI.GetLeader( groupID | entityID )
Returns: the leader's name of the given groupID / entity
ParameterDescription
groupIDgroup id
entityIDentity (id) of which we want to find the leader

SetLeader

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.

Syntax
AI.SetLeader( entityID )
Returns: true if the leader creation/association has been successful
ParameterDescription
entityIDentity (id) of which to which we want to associate a leader class

GetBeaconPosition

get the beacon's position for the given entity/object's group.

Syntax
AI.GetBeaconPosition( entityId | AIObjectName, returnPos )
Returns: true if the beacon has been found and the position set
ParameterDescription
entityId | AIObjectNameAI's entity id | AI object name
returnPosvector {x,y,z} where the beacon position will be set

SetBeaconPosition

Set the beacon's position for the given entity/object's group.

Syntax
AI.SetBeaconPosition( entityId | AIObjectName, pos )
ParameterDescription
entityId | AIObjectNameAI's entity id | AI object name
posbeacon position vector {x,y,z}

RequestAttack

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_*)

Syntax
AI.RequestAttack( entityId, unitProperties, attackTypeList [,duration] )
ParameterDescription
entityIdAI's entity id which group/leader is determined
unitPropertiesbinary mask of unit properties type for which the attack is requested (in the form of UPR_* + UPR* i.e. UPR_COMBAT_GROUND + UPR_COMBAT_FLIGHT) see IAgent.h for definition of unit properties UPR_*
attackTypeLista lua table which contains the list of preferred attack strategies (Leader action subtypes), sorted by priority (most preferred first) the list must be in the format {LAS_*, LAS_*,..} i.e. (LAS_ATTACK_ROW,LAS_ATTACK_FLANK} means that first an Attack_row action will be tried, then an attack_flank if the first ends/fails. see IAgent.h for definition of LeaderActionSubtype (LAS_*) action types
duration(optional) max duration in sec (default = 0)

GetGroupTarget

Returns the most threatening attention target amongst the agents in the given entity's group. (see IAgent.h for definition of alert status)

Syntax
AI.GetGroupTarget( entityId [,bHostileOnly [,bLiveOnly]] )
ParameterDescription
entityIdAI's entity id which group is determined
bHostileOnly (optional)filter only hostile targets in group
bLiveOnly (optional)filter only live targets in group (entities)

GetGroupTargetType

Syntax
AI.GetGroupTargetType( groupID )

GetGroupTargetThreat

Syntax
AI.GetGroupTargetThreat( groupID )

GetGroupTargetEntity

Syntax
AI.GetGroupTargetEntity( groupID )

GetGroupScriptTable

Syntax
AI.GetGroupScriptTable( groupID )

GetGroupTargetCount

Returns the number of attention targets amongst the agents in the given entity's group.

Syntax
AI.GetGroupTargetCount( entityId [,bHostileOnly [,bLiveOnly]] )
ParameterDescription
entityIdAI's entity id which group is determined
bHostileOnly (optional)filter only hostile targets in group
bLiveOnly (optional)filter only live targets in group (entities)

GetGroupAveragePosition

gets the average position of the (leader's) group members

Syntax
AI.GetGroupAveragePosition( entityId, properties, returnPos )
Returns: Pos returned average position
ParameterDescription
entityIdAI's entity id which group/leader is determined
unitPropertiesbinary mask of unit properties type for which the attack is requested (in the form of UPR_* + UPR* i.e. UPR_COMBAT_GROUND + UPR_COMBAT_FLIGHT) see IAgent.h for definition of unit properties UPR_*

FindObjectOfType

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).

Syntax
AI.FindObjectOfType( entityId, radius, AIObjectType, flags [,returnPosition [,returnDirection]] ) AI.FindObjectOfType( position, radius, AIObjectType, [,returnPosition [,returnDirection]] ) 
Returns: the found AIObject's name (nil if not found)
ParameterDescription
entityIdAI's entity id as a center position of the search (if 1st parameter is not a vector)
positioncenter position of the search (if 1st parameter is not an entity id)
radiusradius inside which the object must be found
AIObjectTypeAIObject type; see ScriptBindAI.cpp and Scripts/AIAnchor.lua for a complete list of AIObject types available
flagsfilter for AI Objects to search, which can be the sum of one or more of the following values: AIFAF_VISIBLE_FROM_REQUESTER: Requires whoever is requesting the anchor to also have a line of sight to it AIFAF_VISIBLE_TARGET: Requires that there is a line of sight between target and anchor AIFAF_INCLUDE_DEVALUED: don't care if the object is devalued AIFAF_INCLUDE_DISABLED: don't care if the object is disabled
(optional) returnPositionposition of the found object
(optional) returnDirectiondirection of the found object

GetAnchor

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).

Syntax
AI.GetAnchor( entityId, radius, AIAnchorType, searchType [,returnPosition [,returnDirection]] )
Returns: the found Anchor's name (nil if not found)
ParameterDescription
entityIdAI's entity id as a center position of the search
radiusradius inside which the object must be found. Alternatively a search range can be specified {min=minRad,max=maxRad}.
AIAnchorTypeAnchor type; see Scripts/AIAnchor.lua for a complete list of Anchor types available
searchTypesearch type filter, which can be one of the following values: AIANCHOR_NEAREST: (default) the nearest anchor of the given type AIANCHOR_NEAREST_IN_FRONT: the nearest anchor inside the front cone of entity AIANCHOR_NEAREST_FACING_AT: the nearest anchor of given type which is oriented towards entity's attention target (...Dejan? ) AIANCHOR_RANDOM_IN_RANGE: a random anchor of the given type AIANCHOR_NEAREST_TO_REFPOINT: the nearest anchor of given type to the entity's reference point
(optional) returnPositionposition of the found object
(optional) returnDirectiondirection of the found object

GetNearestEntitiesOfType

Syntax
AI.GetNearestEntitiesOfType( entityId|objectname|position, AIObjectType, maxObjects, returnList [,objectFilter [,radius]] )
Returns: the number of found entities
ParameterDescription
entityId | objectname |positionAI's entity id | name| position as a center position of the search
radiusradius inside which the entities must be found
AIObjectTypeAIObject type; see ScriptBindAI.cpp and Scripts/AIAnchor.lua for a complete list of AIObject types available
maxObjectsmaximum number of objects to find
return listLua table which will be filled up with the list of the found entities (Lua handlers)
(optional) objectFiltersearch type filter, which can be the sum of one or more of the following values: AIOBJECTFILTER_SAMEFACTION: AI objects of the same species of the querying object AIOBJECTFILTER_SAMEGROUP: AI objects of the same group of the querying object or with no group AIOBJECTFILTER_NOGROUP :AI objects with Group ID ==AI_NOGROUP AIOBJECTFILTER_INCLUDEINACTIVE :Includes objects which are inactivated.

GetAIObjectPosition

get the given AIObject's position.

Syntax
AI.GetAIObjectPosition( entityId | AIObjectName )
Returns: AI Object position vector {x,y,z}
ParameterDescription
entityId | AIObjectNameAI's entity id | AI object name

IgnoreCurrentHideObject

Marks the current hideobject unreachable (will be omitted from future hidespot selections).

Syntax
AI.IgnoreCurrentHideObject( entityId )
ParameterDescription
entityIdAI's entity id

GetCurrentHideAnchor

Returns the name of the current anchor the entity is using for cover.

Syntax
AI.GetCurrentHideAnchor( entityId )
ParameterDescription
entityIdAI's entity id

GetAttentionTargetOf

returns the given entity's attention target.

Syntax
AI.GetAttentionTargetOf( entityId )
Returns: attention target's name (nil if no target)
ParameterDescription
entityIdAI's entity id

GetAttentionTargetAIType

returns the given entity's attention target AI type (AIOBJECT_*).

Syntax
AI.GetAttentionTargetAIType( entityId )
Returns: attention target's type (AIOBJECT_NONE if no target)
ParameterDescription
entityIdAI's entity id

GetAttentionTargetType

returns the given entity's attention target type (AITARGET_*).

Syntax
AI.GetAttentionTargetType( entityId )
Returns: attention target's type (AITARGET_NONE if no target)
ParameterDescription
entityIdAI's entity id

GetAttentionTargetEntity

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).

Syntax
AI.GetAttentionTargetEntity( entityId )
Returns: attention target's entity
ParameterDescription
entityIdAI's entity id

GetAttentionTargetPosition

returns the given entity's attention target's position.

Syntax
AI.GetAttentionTargetPosition( entityId, returnPos )
Returns: Pos - vector {x,y,z} passed as a return value (attention target 's position)
ParameterDescription
entityIdAI's entity id

GetAttentionTargetDirection

returns the given entity's attention target's direction.

Syntax
AI.GetAttentionTargetDirection( entityId, returnDir )
Returns: Dir - vector {x,y,z} passed as a return value (attention target 's direction)
ParameterDescription
entityIdAI's entity id

GetAttentionTargetViewDirection

returns the given entity's attention target's view direction.

Syntax
AI.GetAttentionTargetViewDirection( entityId, returnDir )
Returns: Dir - vector {x,y,z} passed as a return value (attention target 's direction)
ParameterDescription
entityIdAI's entity id

GetAttentionTargetDistance

returns the given entity's attention target's distance to the entity.

Syntax
AI.GetAttentionTargetDistance( entityId )
Returns: distance to the attention target (nil if no target)
ParameterDescription
entityIdAI's entity id

GetAttentionTargetThreat

Syntax
AI.GetAttentionTargetThreat( entityID )

UpTargetPriority

modifies the current entity's target priority for the given target if the given target is among the entity's target list.

Syntax
AI.UpTargetPriority( entityId, targetId, increment )
ParameterDescription
entityIdAI's entity id
targetIdtarget's entity id
incrementvalue to modify the target's priority

DropTarget

Clears the target from the AI's perception handler.

Syntax
AI.DropTarget( entityId, targetId )
ParameterDescription
entityIdAI's entity id
targetIdtarget's entity id

ClearPotentialTargets

Clears all the potential targets from the AI's perception handler.

Syntax
AI.ClearPotentialTargets( entityId )
ParameterDescription
entityIdAI's entity id

SetTempTargetPriority

Set the selection priority of the temp target over other potential targets.

Syntax
AI.SetTempTargetPriority( entityId, priority )
Returns: true if updated
ParameterDescription
entityIdAI's entity id
priorityNew priority value

AddAggressiveTarget

Add the target Id as an aggressive potential target to the entity's list.

Syntax
AI.AddAggressiveTarget( entityId, targetId )
Returns: true if updated
ParameterDescription
entityIdAI's entity id
targetIdTarget to add to the list

UpdateTempTarget

Updates the entity's temporary potential target to the given position.

Syntax
AI.UpdateTempTarget( entityId, vPos )
Returns: true if updated
ParameterDescription
entityIdAI's entity id
vPosNew position of the temporary target

ClearTempTarget

Removes the entity's temporary potential target, so it is no longer considered for target selection.

Syntax
AI.ClearTempTarget( entityId )
Returns: true if cleared
ParameterDescription
entityIdAI's entity id

SetExtraPriority

Set a extra priority value to the entity which is given by enemyEntityId.

Syntax
AI.SetExtraPriority( enemyEntityId, increment )
ParameterDescription
enemyEntityIdAI's entity id
float incrementvalue to add to the target's priority

GetExtraPriority

get an extra priority value to the entity which is given by enemyEntityId.

Syntax
AI.GetExtraPriority( enemyEntityId )
ParameterDescription
enemyEntityIdAI's entity id

GetTargetType

Returns the type of current entity's attention target (memory, human, none etc).

Syntax
AI.GetTargetType(entityId)
Returns: Target type value (AITARGET_NONE,AITARGET_MEMORY,AITARGET_BEACON,AITARGET_ENEMY etc) - see IAgent.h for all definitions of target types.
ParameterDescription
entityIdAI's entity id

GetTargetSubType

Returns the subtype of current entity's attention target.

Syntax
AI.GetTargetSubType(entityId)
Returns: Target subtype value - see IAgent.h for all definitions of target types
ParameterDescription
entityIdAI's entity id

RegisterTargetTrack

Registers the AI object to use the given target track configuration for target selection.

Syntax
AI.RegisterTargetTrack(entityId, configuration, targetLimit, classThreat)
Returns: True if registration was successful. Note that this does nothing if 'ai_TargetTracking' is not set to '2'
ParameterDescription
entityIdAI's entity id
configurationTarget stimulus configuration to use
targetLimitNumber of agents who can target the AI at any given time (0 for infinite)
classThreat(Optional) Initial class threat value for the user

UnregisterTargetTrack

Unregisters the AI object with the target track manager.

Syntax
AI.UnregisterTargetTrack(entityId)
Returns: True if unregistration was successful. Note that this does nothing if 'ai_TargetTracking' is not set to '2'.
ParameterDescription
entityIdAI's entity id

SetTargetTrackClassThreat

Sets the class threat for the entity for target track usage.

Syntax
AI.SetTargetTrackClassThreat(entityId, classThreat)
ParameterDescription
entityIdAI's entity id
classThreatClass threat value for the user

CreateStimulusEvent

Creates a target track stimulus event for the entity using the specified data.

Syntax
AI.CreateStimulusEvent(entityId, targetId, stimulusName, pData)
ParameterDescription
ownerIdOwner's entity id (who owns and is receiving the event)
targetIdTarget's entity id (who sent the event, and becomes owner's perceived target)
stimulusNameName of the stimulus event
pDataData about the event (see TargetTrackHelpers::SStimulusEvent)

SoundEvent

Generates a sound event in the AI system with the given parameters.

Syntax
AI.SoundEvent(position, radius, threat, interest, entityId)
ParameterDescription
positionof the origin of the sound event
radiusin which this sound event should be heard
threatvalue of the sound event
interestvalue of the sound event
entityIdof the entity who generated this sound event

VisualEvent

Generates a visual event in the AI system with the given parameters.

Syntax
AI.VisualEvent(entityId, targetId)
ParameterDescription
entityIdwho receives the visual event
targetIdwho the receiver is seeing

GetSoundPerceptionDescriptor

Fills descriptorTable with info about how perception works for the entity dealing with soundType.

Syntax
AI.GetSoundPerceptionDescriptor(entityId, soundType, descriptorTable)
Returns: True if info was returned
ParameterDescription
entityIdwho to get the info from
soundTypewhat type of sound stimulus to get the info for
descriptorTablewhere to store the info once retrieved

SetSoundPerceptionDescriptor

Sets data on how perception works for the entity dealing with soundType.

Syntax
AI.SetSoundPerceptionDescriptor(entityId, soundType, descriptorTable)
Returns: True if info was saved
ParameterDescription
entityIdwho to set the info for
soundTypewhat type of sound stimulus to set the info for
descriptorTableinfo to be set

SetAssesmentMultiplier

set the assesment multiplier factor for the given AIObject type.

Syntax
AI.SetAssesmentMultiplier(AIObjectType, multiplier)
ParameterDescription
AIObjectTypeAIObject type; see ScriptBindAI.cpp for a complete list of AIObject types available
multiplierassesment multiplication factor

SetFactionThreatMultiplier

set the threat multiplier factor for the given species (if 0, species is not hostile to any other). &lt;param name="factionID: factionID&lt;/param&gt; &lt;param name="multiplier"&gt;Threat multiplication factor

Syntax
AI.SetFactionThreatMultiplier(nSpecies, multiplier)

GetRefPointPosition

Get the entity's reference point World position.

Syntax
AI.GetRefPointPosition(entityId)
Returns: (script)vector (x,y,z) reference point position
ParameterDescription
entityIdAI's entity id

GetRefPointDirection

Get the entity's reference point direction.

Syntax
AI.GetRefPointDirection(entityId)
Returns: (script)vector (x,y,z) reference point direction
ParameterDescription
entityIdAI's entity id

SetRefPointPosition

Sets the reference point's World position of an entity

Syntax
AI.SetRefPointPosition(entityId, vRefPointPos)
ParameterDescription
entityIdAI's entity id
vRefPointPos(script)vector (x,y,z) value

SetRefPointDirection

Sets the reference point's World position of an entity

Syntax
AI.SetRefPointDirection( vRefPointDir )
ParameterDescription
vRefPointDir(script)vector (x,y,z) value

SetRefPointRadius

Sets the reference point's radius.

Syntax
AI.SetRefPointRadius(entityId, radius)
ParameterDescription
entityIdAI's entity id
radiusthe radius to set.

SetRefShapeName

Sets the reference shape name.

Syntax
AI.SetRefShapeName(entityId, name)
ParameterDescription
entityIdAI's entity id
namethe name of the reference shape.

GetRefShapeName

Syntax
AI.GetRefShapeName(entityId)
Returns: reference shape name.
ParameterDescription
entityIdAI's entity id

SetTerritoryShapeName

Sets the territory of the AI Actor.

Syntax
AI.SetTerritoryShapeName(entityId, shapeName)
ParameterDescription
entityIdAI's entity id
shapeNamename of the shape to set

SetRefPointAtDefensePos

Set the entity refpoint position in an intermediate distance between the entity's att target and the given point.

Syntax
AI.SetRefPointAtDefensePos(entityId, point2defend, distance)
ParameterDescription
entityIdAI's entity id
point2defendpoint to defend
distancemax distance to keep from the point

SetPathToFollow

Set the name of the path to be used in 'followpath' goal operation.

Syntax
AI.SetPathToFollow(entityId, pathName)
ParameterDescription
entityIdAI's entity id
pathName(string) name of the path to set to be followed.

SetPathAttributeToFollow

Set the attribute of the path to be used in 'followpath' goal operation.

Syntax
AI.SetPathAttributeToFollow(entityId, flag)
ParameterDescription
entityIdAI's entity id
flag.

GetNearestPathOfTypeInRange

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.

Syntax
AI.GetNearestPathOfTypeInRange(entityId, pos, range, type [, devalue, useStartNode])
ParameterDescription
entityIdAI's entity id
posa vector specifying to the point of interest. Path nearest to this position is returned.
rangesearch range. If useStartNode=1, paths whose start point are within this range are returned or if useStartNode=0 nearest distance to the path is calculated and compared against the range.
typetype of path to return.
devalue(optional) specifies the time the returned path is marked as occupied.
useStartNode(optional) if set to 1 the range check will use distance to the start node on the path, else nearest distance to the path is used.

GetTotalLengthOfPath

Syntax
AI.GetTotalLengthOfPath( entityId, pathname )
Returns: a total length of the path
ParameterDescription
entityIdAI's entity id
pathnamedesigners path name

GetNearestPointOnPath

Syntax
AI.GetNearestPointOnPath( entityId, pathname, vPos )
Returns: a nearest point on the path from vPos
ParameterDescription
entityIdAI's entity id
pathnamedesigners path name
vPos.

GetPathSegNoOnPath

Syntax
AI.GetPathSegNoOnPath( entityId, pathname, vPos )
Returns: segment ratio ( 0.0 start point 100.0 end point )
ParameterDescription
entityIdAI's entity id
pathnamedesigner's path name
vPos.

GetPointOnPathBySegNo

Syntax
AI.GetPathSegNoOnPath( entityId, pathname, segNo )
Returns: returns point by segment ratio ( 0.0 start point 100.0 end point )
ParameterDescription
entityIdAI's entity id
pathnamedesigner's path name
segNosegment ratio

GetPathLoop

Syntax
AI.GetPathSegNoOnPath( entityId, pathname )
Returns: returns true if the path is looped
ParameterDescription
entityIdAI's entity id
pathnamedesigner's path name

GetPredictedPosAlongPath

Gets the agent predicted position along his path at a given time

Syntax
AI.GetPredictedPosAlongPath( entityId, time, retPos )
Returns: true if successful
ParameterDescription
entityIdAI's entity id
timeprediction time (sec)
retPosreturn point value

SetPointListToFollow

Set a point list for followpath goal op

Syntax
AI.SetPointListToFollow(entityId, pointlist, howmanypoints, bspline [, navtype])
ParameterDescription
entityIdAI's entity id
pointListshould be like below local vectors = { { x = 0.0, y = 0.0, z = 0.0 },
howmanypoints.
bsplineif true, the line is recalcurated by spline interpolation.
navtype(optional) specify a navigation type ( default = IAISystem::NAV_FLIGHT )

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)
ParameterDescription
entityIdAI's entity id
positionthe position to check

GetNearestHidespot

Syntax
AI.GetNearestHidespot(entityId, rangeMin, rangeMax [, center])
Returns: position of a nearest hidepoint within specified range, returns nil if no hidepoint is found.
ParameterDescription
entityIdAI's entity id
rangeMinspecifies the min range where the hidepoints are looked for.
rangeMaxspecifies the max range where the hidepoints are looked for.
centre(optional) specifies the centre of search. If not specified, the entity position is used.

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
ParameterDescription
positionthe position to check
typethe type of the shapes to check against (uses anchor types).
checkHeight(optional) Default=false, if the flag is set the height of the shape is tested too. The test will check space between the shape.aabb.min.z and shape.aabb.min.z+shape.height.

IsPointInsideGenericShape

Syntax
AI.IsPointInsideGenericShape(position, shapeName[, checkHeight])
Returns: true if the point is inside the specified shape.
ParameterDescription
positionthe position to check
shapeNamethe name of the shape to test (returned by AI.GetEnclosingGenericShapeOfType)
checkHeight(optional) Default=false, if the flag is set the height of the shape is tested too. The test will check space between the shape.aabb.min.z and shape.aabb.min.z+shape.height.

ConstrainPointInsideGenericShape

Syntax
AI.ConstrainPointInsideGenericShape(position, shapeName[, checkHeight])
Returns: the nearest point inside specified shape.
ParameterDescription
positionthe position to check
shapeNamethe name of the shape to use as constraint.
checkHeight(optional) Default=false, if the flag is set the height should be constrained too.

DistanceToGenericShape

Syntax
AI.DistanceToGenericShape(position, shapeName[, checkHeight])
Returns: true if the point is inside the specified shape.
ParameterDescription
positionthe position to check
shapeNamethe name of the shape to test (returned by AI.GetEnclosingGenericShapeOfType)
checkHeight(optional) if the flag is set the height of the shape is tested too. The test will check space between the shape.aabb.min.z and shape.aabb.min.z+shape.height.

CreateTempGenericShapeBox

Creates a temporary box shaped generic shape (will be destroyed upon AIsystem reset).

Syntax
AI.CreateTempGenericShapeBox(center, radius, height, type)
Returns: the name of the shape.
ParameterDescription
centerthe center of the box
radiusthe extend of the box in x and y directions.
heightthe height of the box.
typethe AIanchor type of the shape.

GetObjectRadius

Syntax
AI.GetObjectRadius(entityId)
Returns: the radius of specified AI object.
ParameterDescription
entityIdAI's entity id

GetProbableTargetPosition

Syntax
AI.GetProbableTargetPosition(entityId)
Returns: the probable target position of the AI.
ParameterDescription
entityIdAI's entity id

EvalPeek

Evaluates if an AI object can peek from his current position.

Syntax
AI.EvalPeek(entityId [, bGetOptimalSide])
Returns: -1 - don't need to peek 0 - cannot peek 1 - can peek from left 2 - can peek from right 3 - can peek from left & right
ParameterDescription
entityIdAI's entity id
bGetOptimalSide (optional)If TRUE, and AI object can peek from both sides, will return the side that best fits where the attention target currently is

AddPersonallyHostile

Syntax
AI.AddPersonallyHostile(entityID, hostileID)

RemovePersonallyHostile

Syntax
AI.RemovePersonallyHostile(entityID, hostileID)

ResetPersonallyHostiles

Syntax
AI.ResetPersonallyHostiles(entityID, hostileID)

IsPersonallyHostile

Syntax
AI.IsPersonallyHostile(entityID, hostileID)

GetDirectAnchorPos

Syntax
AI.GetDirectAttackPos(entityId, searchRange, minAttackRange)
Returns: a cover point which can be used to directly attack the attention target, nil if no attack point is available.
ParameterDescription
entityIdAI's entity id
AIAnchorTypeAnchor type; see Scripts/AIAnchor.lua for a complete list of Anchor types available
maxDistsearch range

GetPotentialTargetCountFromFaction

Retrieves the number of potential targets for an entity from a specified factions.

Syntax
AI.GetPotentialTargetCountFromFaction( entityID, name )
ParameterDescription
entityIdid handle of entity to match against.
namename of specified faction.

GetPotentialTargetCount

Retrieves the number of potential targets for an entity from a specified factions.

Syntax
AI.GetPotentialTargetCount( entityID )
ParameterDescription
entityIdid handle of entity to match against.

CreateFormation

Creates a formation descriptor and adds a fixed node at 0,0,0 (owner's node).

Syntax
AI.CreateFormation( name )
ParameterDescription
namename of the new formation descriptor.

AddFormationPointFixed

Adds a node with a fixed offset to a formation descriptor.

Syntax
AI.AddFormationPointFixed(name, sightangle, x, y, z [,unit_class])
ParameterDescription
namename of the formation descriptor
sightangleangle of sight of the node (-180,180; 0 = the guy looks forward)
x, y, zoffset from formation owner
unit_classclass of soldier (see eSoldierClass definition in IAgent.h)

AddFormationPoint

Adds a follow-type node to a formation descriptor. &lt;param name="distanceAlt (optional)- alternative distance from the formation owner (if 0, distanceAlt and offsetAlt will be set respectively to distance and offset)&lt;/param&gt; &lt;param name="offsetAlt (optional)"&gt;alternative X offset

Syntax
AI.AddFormationPoint(name, sightangle, distance, offset, [unit_class [,distanceAlt, offsetAlt]] )
ParameterDescription
namename of the formation descriptor
sightangleangle of sight of the node (-180,180; 0 = the guy looks forward)
distancedistance from the formation's owner
offsetX offset along the following line (negative = left, positive = right)
unit_classclass of soldier (see eSoldierClass definition in IAgent.h)

GetFormationPointClass

Adds a follow-type node to a formation descriptor.

Syntax
AI.AddFormationPoint(name, position )
Returns: class of specified formation point (-1 if not found)
ParameterDescription
namename of the formation descriptor
positionpoint index in the formation (1..N)

GetFormationPointPosition

Gets the AI's formation point position.

Syntax
AI.GetFormationPointPosition(entityId, pos)
Returns: true if the formation point has been found
ParameterDescription
entityIdAI's entity id
posreturn value- position of entity AI's current formation point if there is

BeginTrackPattern

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().

Syntax
AI.BeginTrackPattern( patternName, flags, validationRadius, [stateTresholdMin],
ParameterDescription
patternNamename of the new track pattern descriptor
flagsThe functionality flags of the track pattern. Validation: The validation method describes how the pattern is validated to fit the physical world. Should be one of: AITRACKPAT_VALIDATE_NONE - no validation at all. AITRACKPAT_VALIDATE_SWEPTSPHERE - validate using swept sphere tests, the spehre radius is validation radius plus the entity pass radius. AITRACKPAT_VALIDATE_RAYCAST - validate using raycasting, the hit position is pulled back by the amount of validation radius plus the entity pass radius. Aligning: When the pattern is selected to be used the alignment of the patter ncan be changed. The alignment can be combination of the following. The descriptions are in order they are evaluated. AITRACKPAT_ALIGN_TO_TARGET - Align the pattern so that the y-axis will point towards the target each time it is set. If the agent does not have valid attention target at the time the pattern is set the pattern will be aligned to the world. AITRACKPAT_ALIGN_RANDOM - Align the pattern randonly each time it is set. The rotation ranges are set using SetRandomRotation().
validationRadiusthe validation radius is added to the entity pass radius when validating the pattern along the offsets.
stateTresholdMin (optional)If the state of the pattern is 'enclosed' (high deformation) and the global deformation < stateTresholdMin, the state becomes exposed. Default 0.35.
stateTresholdMax (optional)If the state of the pattern is 'exposed' (low deformation) and the global deformation > stateTresholdMax, the state becomes enclosed. Default 0.4.
globalDeformTreshold (optional)the deformation of the whole pattern is tracked in range [0..1]. This treshold value can be used to clamp the bottom range, so that values in range [trhd..1] becomes [0..1], default 0.0.
localDeformTreshold (optional)the deformation of the each node is tracked in range [0..1]. This treshold value can be used to clamp the bottom range, so that values in range [trhd..1] becomes [0..1], default 0.0.
exposureMod (optional)the exposure modifier allows to take the node exposure (how much it is seen by the tracked target) into account when branching. The modifier should be in range [-1..1], -1 means to favor unseen nodes, and 1 means to favor seen, exposed node. Default 0 (no effect).
randomRotAng (optional)each time the pattern is set, it can be optionally rotated randomly. This parameter allows to define angles (in degrees) around each axis. The rotation is performed in XYZ order.

AddPatternNode

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 descriptor, and hte system does not try to correct the evaluation order. In case hierarchies are used (parent name is defined) it is up to the pattern creator to make sure the nodes are created in such order that the parent is added before it is referenced.

Syntax
AI.AddPatternNode( nodeName, offsetx, offsety, offsetz, flags, [parent], [signalValue] )
ParameterDescription
nodeNamename of the new point, the point names are local to the pattern that is currently being specified.
offsetx, offsety, offsetzThe offset from the start position or from the pattern center, see AITRACKPAT_NODE_ABSOLUTE.
flagsDefines the node evaluation flags, the flags are as follows and can be combined: AITRACKPAT_NODE_START - If this flag is set, this node can be used as the first node in the pattern. There can be multiple start nodes. In that case the closest one is chosen. AITRACKPAT_NODE_ABSOLUTE - If this flag is set, the offset is interpret as an offset from the pattern center, otherwise the offset is offset from the start position. AITRACKPAT_NODE_SIGNAL - If this flag is set, a signal "OnReachedTrackPatternNode" will be send when the node is reached. AITRACKPAT_NODE_STOP - If this flag is set, the advancing will be stopped, it can be continue by calling entity:ChangeAIParameter( AIPARAM_TRACKPATTERN_ADVANCE, 1 ). AITRACKPAT_NODE_DIRBRANCH - The default direction at each pattern node is direction from the node position to the center of the pattern If this flag is set, the direction will be average direction to the branch nodes.
parent (optional)If this parameter is set, the start position is considered to be the parent node position instead of the pattern center.
signalValue (optional)If the signal flag is set, this value will be passed as signal parameter, it is accessible from the signal handler in data.iValue.

AddPatternBranch

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.

Syntax
AI.AddPatternBranch( nodeName, method, branchNode1, branchNode2, ..., branchNodeN )
ParameterDescription
nodeNamename of the node to add the branches.
methodThe method to choose the next node when the node is reached. Should be one of the following: AITRACKPAT_CHOOSE_ALWAYS - Chooses on node from the list in linear sequence. AITRACKPAT_CHOOSE_LESS_DEFORMED - Chooses the least deformed point in the list. Each node is associated with a deformation value (percentage) which describes how much it was required to move in order to stay within the physical world. These deformation values are summed down to the parent nodes so that deformation at the end of the hierarchy will be caught down the hierarchy. AITRACKPAT_CHOOSE_RANDOM - Chooses one point in the list randomly.

EndTrackPattern

Finalizes the track pattern definition. This function should always called to finalize the pattern. Failing to do so will cause erratic behavior.

Syntax
AI.EndTrackPattern()

ChangeFormation

Changes the formation descriptor for the current formation of given entity's group (if there is a formation).

Syntax
AI.ChangeFormation(entityId, name [,scale] )
Returns: true if the formation change was successful
ParameterDescription
entityIdentity id of which group the formation is changed
namename of the formation descriptor
scale (optional)scale factor (1 = default)

ScaleFormation

changes the scale factor of the given entity's formation (if there is).

Syntax
AI.ScaleFormation(entityId, scale)
Returns: true if the formation scaling was successful
ParameterDescription
entityIdentity id of which group the formation is scaled
scalescale factor

SetFormationUpdate

Changes the update flag of the given entity's formation (if there is) - the formation is no more updated if the flag is false.

Syntax
AI.SetFormationUpdate(entityId, update)
Returns: true if the formation update setting was successful
ParameterDescription
entityIdentity id of which group the formation is scaled
updateupdate flag (true/false)

SetFormationUpdateSight

Sets a random angle rotation for the given entity's formation sight directions.

Syntax
AI.SetFormationUpdateSight(entityId, range, minTime, maxTime )
ParameterDescription
entityIdentity id owner of the formation
rangeangle (0,360) of rotation around the default sight direction
minTime (optional)minimum timespan for changing the direction (default = 2)
maxTime (optional)minimum timespan for changing the direction (default = minTime)

GetNavigationType

returns the navigation type value at the specified entity's position, given the entity navigation properties.

Syntax
AI.GetNavigationType(entityId)
Returns: navigation type at the entity's position (NAV_TRIANGULAR,NAV_WAYPOINT_HUMAN,NAV_ROAD,NAV_VOLUME,NAV_WAYPOINT_3DSURFACE, NAV_FLIGHT,NAV_SMARTOBJECT) see IAISystem::ENavigationType definition
ParameterDescription
entityIdAI's entity id

GetDistanceAlongPath

returns the distance between entity1 and entity2, along entity1's path.

Syntax
AI.GetDistanceAlongPath(entityId1, entityid2)
Returns: distance along entity1 path; distance value would be negative if the entity2 is ahead along the path
ParameterDescription
entityId1AI's entity1 id
entityId2AI's entity2 id

IntersectsForbidden

check if the line is in a Forbidden Region.

Syntax
AI.IsPointInFlightRegion(start, end)
Returns: intersected position or end (if there is no intersection)
ParameterDescription
starta vector in format {x,y,z}
enda vector in format {x,y,z}

IsPointInFlightRegion

Check if the point is in the Flight Region. &lt;param name="point: a vector in format {x,y,z}

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

IsPointInWaterRegion

Check if the point is in the Flight Region. &lt;param name="point: a vector in format {x,y,z}

Syntax
AI.IsPointInFlightRegion(point)
Returns: water level - ground level, values greater than 0 mean there is water.

SetFireMode

Immediately sets firemode.

Syntax
AI.SetFireMode(entityId, mode)
ParameterDescription
entityIdAI's entity id
firemodenew firemode

SetMemoryFireType

Sets how the puppet handles firing at its memory target.

Syntax
AI.SetMemoryFireType(entityId, type)
ParameterDescription
entityIdAI's entity id
typeMemory fire type (see EMemoryFireType)

GetMemoryFireType

Syntax
AI.GetMemoryFireType(entityId)
Returns: How the puppet handles firing at its memory target.
ParameterDescription
entityIdAI's entity id

ThrowGrenade

Throws a specified grenade at target type without interrupting fire mode.

Syntax
AI.ThrowGrenade(entityId, grenadeType, regTargetType)
ParameterDescription
entityIdAI's entity id
grenadeTypeRequested grenade type (see ERequestedGrenadeType)
regTargetTypeWho to throw at (see AI_REG_*)

EnableCoverFire

Enables/disables fire when the FIREMODE_COVER is selected.

Syntax
AI.EnableCoverFire(entityId, enable)
ParameterDescription
entityIdAI's entity id
enableboolean

EnableFire

Enables/disables fire.

Syntax
AI.EnableFire(entityId, enable)
ParameterDescription
entityIdAI's entity id
enableboolean

IsFireEnabled

Checks if AI is allowed to fire or not.

Syntax
AI.IsFireEnabled(entityId)
Returns: True if AI is enabled to fire
ParameterDescription
entityIdAI's entity id

CanFireInStance

Syntax
AI.CanFireInStance(entityId, stance)
Returns: true if AI can fire at his target in the given stance at his current position
ParameterDescription
entityIdAI's entity id
stanceStance Id (STANCE_*)

SetUseSecondaryVehicleWeapon

Sets if the AI should use the secondary weapon when firing from a vehicle gunner seat if possible.

Syntax
AI.SetUseSecondaryVehicleWeapon(entityId, bUseSecondary)
ParameterDescription
entityIdAI's entity id
bUseSecondaryTRUE to use the secondary weapon

SetPFBlockerRadius

Syntax
AI.SetPFBlockerRadius(entityId, blocker, radius)
ParameterDescription
entityIdAI's entity id

IsAgentInTargetFOV

Checks if the entity is in the FOV of the attention target.

Syntax
AI.IsAgentInTargetFOV(entityId, fov)
Returns: true if in the FOV of the attention target else false.
ParameterDescription
entityIdAI's entity id.
fovFOV of the enemy in degrees.

AgentLookAtPos

Makes the entityId look at certain position.

Syntax
AI.AgentLookAtPos(entityId, pos)
ParameterDescription
entityIdAI's entity id.
fovvec3 to look at

ResetAgentLookAtPos

Makes the entityId resets a previous call to AgentLookAtPos().

Syntax
AI.ResetAgentLookAtPos(entityId)
ParameterDescription
entityIdAI's entity id.

IsAgentInAgentFOV

Check if the entity2 is within the entity FOV.

Syntax
AI.IsAgentInAgentFOV(entityId, entityId2)
Returns: 1st value - TRUE if the agent is within the entity FOV 2nd value - TRUE if the agent is within the entity's primary FOV or FALSE if within secondary FOV
ParameterDescription
entityIdAI's entity who's FOV is checked
entityId2that's entity is looking for ;)

CreateGroupFormation

Creates a group formation with leader (or updates leader).

Syntax
AI.CreateGroupFormation(entityId, leaderId)
ParameterDescription
entityIdAI's entity
leaderIdNew leader

SetFormationPosition

Sets the Relative position inside the formation.

Syntax
AI.SetFormationPosition(entityId, v2RelativePosition )
ParameterDescription
entityIdAI's entity
v2RelativePositionTable with format {x,y} storing the new relative position

SetFormationLookingPoint

Sets the Relative looking point position inside the formation.

Syntax
AI.SetFormationLookingPoint(entityId, v3RelativePosition )
ParameterDescription
entityIdAI's entity
v3RelativePositionTable with format {x,y,z} storing the new relative looking point

SetFormationAngleThreshold

Sets the Relative position inside the formation.

Syntax
AI.SetFormationAngleThreshold(entityId, fAngleThreshold )
ParameterDescription
entityIdAI's entity
fAngleThresholdNew Leader orientation angle threshold in degrees to recal position

GetFormationPosition

Gets the Relative position inside the formation.

Syntax
AI.GetFormationPosition(entityId)
Returns: v3 - Table with format {x,y,z} storing the relative position
ParameterDescription
entityIdAI's entity

GetFormationLookingPoint

Gets the looking point position inside the formation.

Syntax
AI.GetFormationLookingPoint(entityId)
Returns: v3 - Table with format {x,y,z} storing the looking point position
ParameterDescription
entityIdAI's entity

SetAnimationTag

Syntax
AI.SetAnimationTag(entityId, tagName)
ParameterDescription
entityIdAI's entity
tagName.

ClearAnimationTag

Syntax
AI.ClearAnimationTag(entityId, tagName)
ParameterDescription
entityIdAI's entity
tagName.

GetStance

Get the given entity's stance.

Syntax
AI.GetStance(entityId)
Returns: entity stance (STANCE_*)
ParameterDescription
entityIdAI's entity id

SetStance

Set the given entity's stance.

Syntax
AI.SetStance(entityId, stance)
ParameterDescription
entityIdAI's entity id
stancestance value (STANCE_*)

SetMovementContext

Set the given entity's movement context.

Syntax
AI.SetMovementContext(entityId, context)
ParameterDescription
entityIdAI's entity id
contextcontext value

ClearMovementContext

Reset the given entity's movement context.

Syntax
AI.ResetMovementContext(entityId)
ParameterDescription
entityIdAI's entity id
contextcontext value

SetPostures

Set the given entity's postures.

Syntax
AI.SetPostures(entityId, postures)
ParameterDescription
entityIdAI's entity id
postures.

SetPosturePriority

Set the given entity's posture priority.

Syntax
AI.SetPosturePriority(entityId, postureName, priority)

GetPosturePriority

Set the given entity's posture priority.

Syntax
AI.GetPosturePriority(entityId, postureName)

IsMoving

Returns true if the agent desires to move.

Syntax
AI.IsMoving(entityId)
ParameterDescription
entityIdAI's entity id

RegisterDamageRegion

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

Syntax
AI.RegisterDamageRegion(entityId, radius)
ParameterDescription
entityIdowner entity id.
radiusIf radius <= 0 then the region is disabled

GetBiasedDirection

Get biased direction of certain point.

Syntax
AI.GetBiasedDirection(entityId)
ParameterDescription
entityIdAI's entity

SetAttentiontarget

Set a new attention target.

Syntax
AI.SetAttentiontarget(entityId, targetId)
ParameterDescription
entityIdAI's entity
targetIdtarget's id

FindStandbySpotInShape

Syntax
AI.FindStandbySpotInShape(centerPos, targetPos, anchorType)

FindStandbySpotInSphere

Syntax
AI.FindStandbySpotInSphere(centerPos, targetPos, anchorType)

CanMelee

returns 1 if the AI is able to do melee attack.

Syntax
AI.CanMelee(entityId)
ParameterDescription
entityIdAI's entity id

CheckMeleeDamage

returns 1 if the AI performing melee is actually hitting target.

Syntax
AI.CheckMeleeDamage(entityId, targetId, radius, minheight, maxheight, angle)
Returns: (distance,angle) pair between entity and target (degrees) if melee is possible, nil otherwise
ParameterDescription
entityIdAI's entity id
targetIdAI's target entity id
radiusmax distance in 2d to target
minheightmin distance in height
maxheightmax distance in height
angleFOV to include target

GetDirLabelToPoint

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

Syntax
AI.GetDirLabelToPoint(entityId, point)
ParameterDescription
entityIdAI's entity id
pointpoint to evaluate.

DebugReportHitDamage

Creates a debug report for the hit damage.

Syntax
AI.DebugReportHitDamage(pVictimEntity, pShooterEntity)
ParameterDescription
pVictimEntityVictim ID.
pShooterEntityShooter ID.

ProcessBalancedDamage

Processes balanced damage.

Syntax
AI.ProcessBalancedDamage(pShooterEntity, pTargetEntity, damage, damageType)
ParameterDescription
pShooterEntityShooter ID.
pTargetEntityTarget ID.
damageHit damage.
damageTypeHit damage type.

SetRefpointToAnchor

Sets a reference point to an anchor.

Syntax
AI.SetRefpointToAnchor(entityId, rangeMin, rangeMax, findType, findMethod)
ParameterDescription
entityIdAI's entity ID.
rangeMinMinimum range.
rangeMaxMaximum range.
findTypeFinding type.
findMethodFinding method.

SetRefpointToPunchableObject

Sets the reference point to the punchable object.

Syntax
AI.SetRefpointToPunchableObject(entityId, range)
ParameterDescription
entityIdAI's entity ID.
rangeRange for the punchable object.

MeleePunchableObject

Syntax
AI.MeleePunchableObject(entityId, objectId, origPos)
ParameterDescription
entityIdAI's entity ID.
objectIdObject ID.
origPos Position of the melee punchable object

IsPunchableObjectValid

Checks if a punchable object is valid.

Syntax
AI.IsPunchableObjectValid(userId, objectId, origPos)
ParameterDescription
userIdUser ID.
objectIdObject ID.
origPosObject position in the world.

PlayReadabilitySound

Plays readability sound on the AI agent. This call does not do any filtering like playing readability using signals.

Syntax
AI.PlayReadabilitySound(entityId, soundName)
ParameterDescription
entityIdAI's entity id
soundNamethe name of the readability sound signal to play
stopPreviousSounds (Optional)TRUE if any currently playing readability should be stopped in favor of this one
responseDelayMin (Optional)Minimum (or exact, if no maximum) delay for the Response readability to play
repsonseDelayMax (Optional)Maximum delay for the Response readability to play

PlayCommunication

Plays communication on the AI agent.

Syntax
AI.PlayCommunication(entityId, commName, channelName[, targetId] [, targetPos])
ParameterDescription
entityIdAI's entity id
commNameThe name of the communication to play
channelNameThe name of the channel where the communication will play

StopCommunication

Stops given communication.

Syntax
AI.StopCommunication(playID)
ParameterDescription
playIDThe id of the communication to stop.

EnableWeaponAccessory

Enables or disables certain weapon accessory usage.

Syntax
AI.EnableWeaponAccessory(entityId, accessory, state)
ParameterDescription
entityIdAI's entity id
accessoryenum of the accessory to enable (see EAIWeaponAccessories)
statetrue/false to enable/disable

RegisterInterestingEntity

Registers the entity with the interest system. Any errors go to the error log.

Syntax
AI.RegisterInterestingEntity(entityId, baseInterest, category, aiAction)
Returns: true - if a valid update was performed nil - if not (Interest system is disabled, parameters not valid, etc)
ParameterDescription
entityIdAI's entity id

UnregisterInterestingEntity

Unregisters the entity with the interest system. Any errors go to the error log.

Syntax
AI.UnregisterInterestingEntity(entityId)
ParameterDescription
entityIdAI's entity

RegisterInterestedActor

Registers the interested actor with the interest system. Any errors go to the error log.

Syntax
AI.RegisterInterestedActor(entityId, fInterestFilter, fAngleInDegrees)
Returns: true - if a valid update was performed nil - if not (Interest system is disabled, parameters not valid, etc)
ParameterDescription
entityIdAI's entity

UnregisterInterestedActor

Unregisters the entity with the interest system. Any errors go to the error log.

Syntax
AI.UnregisterInterestedActor(entityId)
ParameterDescription
entityIdAI's entity id

IsCoverCompromised

Syntax
AI.IsCoverCompromised(entityId)
Returns: true - Cover is not good anymore nil - if not
ParameterDescription
entityIdAI's entity

SetCoverCompromised

Syntax
AI.SetCoverCompromised(entityId)
ParameterDescription
entityIdAI's entity

IsTakingCover

Syntax
AI.IsTakingCover(entityId, [distanceThreshold])
Returns: true - Agent is either in cover or running to cover nil - if not
ParameterDescription
entityIdAI's entity
distanceThreshold(optional) distance over which if the agent is running to cover, he won't be considered as taking cover

IsMovingInCover

Syntax
AI.IsMovingInCover(entityId)
Returns: true - Agent is moving in cover nil - if not
ParameterDescription
entityIdAI's entity

IsMovingToCover

true - Agent is running to cover nil - if not

Syntax
AI.IsMovingToCover(entityId)
ParameterDescription
entityIdAI's entity

IsInCover

true - if AI is using cover nil - if not

Syntax
AI.IsInCover(entityId)

SetInCover

Syntax
AI.SetInCover(entityId, inCover)
ParameterDescription
entityIdAI's entity
inCoverif the AI should be set to be in cover or not

IsOutOfAmmo

Syntax
AI.IsOutOfAmmo(entityId)
Returns: true - Entity is out of ammo nil - if not
ParameterDescription
entityIdAI's entity

IsLowOnAmmo

Syntax
AI.IsLowOnAmmo(entityId)
ParameterDescription
entityIdAI's entity
thresholdthe ammo percentage threshold

ResetAgentState

Resets a particular aspect of the agent's state, such as "lean". Intended to keep these hacky concepts together.

Syntax
AI.ResetAgentState(entityId,stateLabel)
Returns: nil
ParameterDescription
entityIdAI's entity
stateLabelstring describing the state that must be reset to default

RegisterTacticalPointQuery

Get a query ID for the given tactical point query.

Syntax
AI.RegisterTacticalPointQuery( querySpecTable )
Returns: > 0 - If the query was parsed successfully 0 - Otherwise
ParameterDescription
querySpecTabletable specifying the query (a mini-language - see Tactical Point System docs elsewhere)

GetTacticalPoints

Get a point matching a description, related to an entity. Format of a point is: { x,y,z }.

Syntax
AI.GetTacticalPoints( entityId, tacPointSpec, point )
Returns: true - If a valid point was found false - Otherwise
ParameterDescription
entityIdAI's entity
tacPointSpectable specifying the points required
pointa table put coordinates of point found

DestroyAllTPSQueries

Destroys all the tactical point system queries.

Syntax
AI2.DestroyAllTPSQueries()

GetObjectBlackBoard

retrieves given object's black board (a Lua table).

Syntax
AI.GetObjectBlackBoard( entity )
Returns: black board - if there was one nil - Otherwise
ParameterDescription
entityId or entityNamesome kind of AI entity's identifier

GetBehaviorBlackBoard

retrieves given AIActor current behaviour's black board (a Lua table).

Syntax
AI.GetBehaviorBlackBoard( entity )
Returns: black board - if there was one nil - Otherwise
ParameterDescription
entityId or entityNamesome kind of AIActors's identifier

SetBehaviorVariable

Sets a behaviour variable for the specified actor.

Syntax
AI.SetBehaviorVariable( entity, variableName, value )

GetBehaviorVariable

Returns a behavior variable for the specified actor.

Syntax
AI.GetBehaviorVariable( entity, variableName, value )

ParseTables

Syntax
AI.ParseTables( firstTable,parseMovementAbility,pH,aiParams,updateAlways )
ParameterDescription
firstTableProperties table.
parseMovementAbilityTrue to parse movement ability, false otherwise.
aiParamsAI parameters.
updateAlways.

GoTo

This function is intended to allow AI Actor (the entity) go to the specified destination.

Syntax
AI.GoTo(entityId, vDestination)
ParameterDescription
entityIdAI's entity
vDestination.

SetSpeed

This function allows the user to override the entity's current speed (urgency).

Syntax
AI.SetSpeed(entityId, urgency)
ParameterDescription
entityIdAI's entity
urgencyfloat value specifying the movement urgency (see AgentMovementSpeeds::EAgentMovementUrgency)

SetEntitySpeedRange

Syntax
AI.SetEntitySpeedRange( userEntityId, urgency, defaultSpeed, minSpeed, maxSpeed, stance = all)
Returns: true if the operation was successful and false otherwise
ParameterDescription
usedEntityIdentity id of the user for which its last used smart object is needed
urgencyinteger value specifying the movement urgency (see AgentMovementSpeeds::EAgentMovementUrgency)
defaultSpeedfloating point value specifying the default speed
minSpeedfloating point value specifying the min speed

SetAlarmed

This function sets the entity to be "perception alarmed".

Syntax
AI.SetAlarmed( entityId )

LoadBehaviors

Syntax
AI.LoadBehaviors( folderName, extension, globalEnv)

IsLowHealthPauseActive

Syntax
AI.IsLowHealthPauseActive( entityID )

GetPreviousBehaviorName

Syntax
AI.GetPreviousBehaviorName( entityID )

SetContinuousMotion

Syntax
AI.SetContinuousMotion( entityID, continuousMotion )

GetPeakThreatLevel

Syntax
AI.GetPeakThreatLevel( entityID )

GetPeakThreatType

Syntax
AI.GetPeakThreatType( entityID )

GetPreviousPeakThreatLevel

Syntax
AI.GetPreviousPeakThreatLevel( entityID )

GetPreviousPeakThreatType

Syntax
AI.GetPreviousPeakThreatType( entityID )

CheckForFriendlyAgentsAroundPoint

Syntax
AI.CheckForFriendlyAgentsAroundPoint( entityID, point, radius)

EnableUpdateLookTarget

Syntax
AI.EnableUpdateLookTarget(entityID, bEnable)

SetBehaviorTreeEvaluationEnabled

Syntax
AI.SetBehaviorTreeEvaluationEnabled(entityID, enable)

UpdateGlobalPerceptionScale

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

QueueBubbleMessage

Syntax
AI.QueueBubbleMessage(entityID, message, flags)

SequenceBehaviorReady

Syntax
AI.SequenceBehaviorReady(entityId)

SequenceInterruptibleBehaviorLeft

Syntax
AI.SequenceInterruptibleBehaviorLeft(entityId)

SequenceNonInterruptibleBehaviorLeft

Syntax
AI.SequenceNonInterruptibleBehaviorLeft(entityId)

SetCollisionAvoidanceRadiusIncrement

Syntax
AI.SetCollisionAvoidanceRadiusIncrement(entityId, radius)

RequestToStopMovement

Syntax
AI.RequestToStopMovement(entityId)

GetDistanceToClosestGroupMember

Syntax
AI.GetDistanceToClosestGroupMember(entityId)

IsAimReady

Syntax
AI.IsAimReady(entityIdHandle)

AllowLowerBodyToTurn

Syntax
AI.LockBodyTurn(entityID, bAllowLowerBodyToTurn)
ParameterDescription
entityIdentity id of the agent you want to set the look style to
bAllowLowerBodyToTurntrue if you want to allow the turning movement of the body, false otherwise

GetGroupScopeUserCount

Syntax
AI.GetGroupScopeUserCount(entityID, bAllowLowerBodyToTurn)
Returns: The amount of actors inside the group scope (>= 0) or nil if an error occurred.
ParameterDescription
entityIdentity id of the agent you want to access the group scope for.
groupScopeNamethe group scope name.
  • No labels