AIGroup Interface Reference

Inheritance diagram for AIGroup:

Public Member Functions
proto external void	AddAgent (AIAgent pAgent)
proto external void	RemoveAgent (AIAgent pAgent)
proto external int	GetAgents (notnull out array< AIAgent > outAgents)
proto external int	GetAgentsCount ()
proto external void	ActivateAllMembers ()
proto external void	DeactivateAllMembers ()
proto external AIFormationComponent	GetFormationComponent ()
proto external void	AddWaypoint (AIWaypoint w)
proto external void	RemoveWaypoint (AIWaypoint w)
proto external void	AddWaypointAt (AIWaypoint w, int index)
proto external void	RemoveWaypointAt (int index)
proto external void	CompleteWaypoint (AIWaypoint w)
	Completes specified waypoint and removes it from the list of waypoints, no need to call RemoveWaypoint.
proto external AIWaypoint	GetCurrentWaypoint ()
proto external int	GetWaypoints (out array< AIWaypoint > outWaypoints)
proto external AIAgent	GetLeaderAgent ()
proto external IEntity	GetLeaderEntity ()
proto external vector	GetCenterOfMass ()
proto external void	SetNewLeader (AIAgent newLeader)
void	OnEmpty ()
void	OnAgentAdded (AIAgent child)
void	OnAgentRemoved (AIAgent child)
void	OnLeaderChanged (AIAgent currentLeader, AIAgent prevLeader)
Public Member Functions inherited from AIAgent
proto external IEntity	GetControlledEntity ()
proto external AIGroup	GetParentGroup ()
proto external void	SetLOD (int newLOD)
proto external int	GetLOD ()
proto external void	SetPermanentLOD (int lod)
proto external int	GetPermanentLOD ()
proto external void	PreventMaxLOD (float preventTime=-1)
proto external void	AllowMaxLOD ()
proto external bool	CountTowardsAIWorldLimit ()
proto external int	GetDangerEventsCount ()
proto AIDangerEvent	GetDangerEvent (int index, out int outCount)
	Internally similar danger events can be aggregated. In that case the new danger event is not put into the queue, but instead counter of previous similar event is increased.
proto external void	ClearDangerEvents (int howMany)
proto external void	ExtractAIEvents (out notnull array< AIWaypoint > aiEvents)
proto external ActionManager	GetActionManager ()
proto external AICommunicationComponent	GetCommunicationComponent ()
proto external AIControlComponent	GetControlComponent ()
proto external AIBaseMovementComponent	GetMovementComponent ()
proto external AIBaseAimingComponent	GetAimingComponent ()
proto external void	ActivateAI ()
proto external void	DeactivateAI ()
proto external bool	IsAIActivated ()
void	OnLODChanged (int oldLOD, int newLOD)

Protected Member Functions
void	OnCurrentWaypointChanged (AIWaypoint currentWP, AIWaypoint prevWP)
void	OnWaypointCompleted (AIWaypoint wp)
void	OnWaypointAdded (AIWaypoint wp)
void	OnWaypointRemoved (AIWaypoint wp, bool isCurrentWaypoint)

Additional Inherited Members
Static Public Member Functions inherited from AIAgent
static proto int	GetMaxLOD ()

Member Function Documentation

ActivateAllMembers()

proto external void AIGroup.ActivateAllMembers

(

)

AddAgent()

proto external void AIGroup.AddAgent

(

AIAgent

pAgent

)

AddWaypoint()

proto external void AIGroup.AddWaypoint

(

AIWaypoint

w

)

AddWaypointAt()

proto external void AIGroup.AddWaypointAt	(	AIWaypoint	w,
		int	index )

CompleteWaypoint()

proto external void AIGroup.CompleteWaypoint

(

AIWaypoint

w

)

Completes specified waypoint and removes it from the list of waypoints, no need to call RemoveWaypoint.

DeactivateAllMembers()

proto external void AIGroup.DeactivateAllMembers

(

)

GetAgents()

proto external int AIGroup.GetAgents

(

notnull out array< AIAgent >

outAgents

)

GetAgentsCount()

proto external int AIGroup.GetAgentsCount

(

)

GetCenterOfMass()

proto external vector AIGroup.GetCenterOfMass

(

)

GetCurrentWaypoint()

proto external AIWaypoint AIGroup.GetCurrentWaypoint

(

)

GetFormationComponent()

proto external AIFormationComponent AIGroup.GetFormationComponent

(

)

GetLeaderAgent()

proto external AIAgent AIGroup.GetLeaderAgent

(

)

GetLeaderEntity()

proto external IEntity AIGroup.GetLeaderEntity

(

)

GetWaypoints()

proto external int AIGroup.GetWaypoints

(

out array< AIWaypoint >

outWaypoints

)

OnAgentAdded()

void AIGroup.OnAgentAdded

(

AIAgent

child

)

Implemented in SCR_AIGroup.

OnAgentRemoved()

void AIGroup.OnAgentRemoved

(

AIAgent

child

)

Implemented in SCR_AIGroup.

OnCurrentWaypointChanged()

void AIGroup.OnCurrentWaypointChanged ( AIWaypoint currentWP, AIWaypoint prevWP )

protected

Implemented in SCR_AIGroup.

OnEmpty()

void AIGroup.OnEmpty

(

)

Implemented in SCR_AIGroup.

OnLeaderChanged()

void AIGroup.OnLeaderChanged	(	AIAgent	currentLeader,
		AIAgent	prevLeader )

Implemented in SCR_AIGroup.

OnWaypointAdded()

void AIGroup.OnWaypointAdded ( AIWaypoint wp )

protected

Implemented in SCR_AIGroup.

OnWaypointCompleted()

void AIGroup.OnWaypointCompleted ( AIWaypoint wp )

protected

Implemented in SCR_AIGroup.

OnWaypointRemoved()

void AIGroup.OnWaypointRemoved ( AIWaypoint wp, bool isCurrentWaypoint )

protected

Implemented in SCR_AIGroup.

RemoveAgent()

proto external void AIGroup.RemoveAgent

(

AIAgent

pAgent

)

RemoveWaypoint()

proto external void AIGroup.RemoveWaypoint

(

AIWaypoint

w

)

RemoveWaypointAt()

proto external void AIGroup.RemoveWaypointAt

(

int

index

)

SetNewLeader()

proto external void AIGroup.SetNewLeader

(

AIAgent

newLeader

)

---

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

• Game/generated/AI/AIGroup.c