AIGroupMovementComponent Interface Reference

Inheritance diagram for AIGroupMovementComponent:

Public Member Functions
proto external void	SetGroupCharactersWantedMovementType (EMovementType movementWanted)
proto external EMovementType	GetGroupCharactersMovementTypeWanted ()
proto external int	GetAgentMoveHandlerId (notnull AIAgent agent)
	Group Movement Handler: Takes care of planning movement and organizing in formation a collection of agents in a group.
proto external int	CreateGroupMoveHandler (string formationType)
proto external int	GetMoveHandlerAgentCount (int handlerId=0)
proto external void	MoveAgentToHandler (notnull AIAgent agent, int originalHandlerId, int newHandlerId)
proto external void	SetMoveHandlerLeader (notnull AIAgent agent, int originalHandlerId, int newHandlerId)
proto external void	RemoveGroupMoveHandler (int handlerId)
proto external void	ClearGroupMoveHandlers ()
proto external bool	SetFormationDefinition (int handlerId, string formation)
proto external AIFormationDefinition	GetFormationDefinition (int handlerId)
proto external void	SetFormationDisplacement (int iValue, int handlerId=0)
	Displacement modifies formation indexes.
proto external int	GetFormationDisplacement (int handlerId=0)
proto AIAgent	GetHandlerLeaderAgent (int handlerId=0)
proto int	GetAgentsInHandler (notnull out array< AIAgent > outAgents, int handlerId=0)
proto external bool	IsFormationDisplaced (int handlerId=0)
void	OnMoveHandlerAdded (int handlerId)
void	OnMoveHandlerRemoved (int handlerId)

Static Public Attributes
const int	DEFAULT_HANDLER_ID = 0

Member Function Documentation

ClearGroupMoveHandlers()

proto external void AIGroupMovementComponent.ClearGroupMoveHandlers

(

)

CreateGroupMoveHandler()

proto external int AIGroupMovementComponent.CreateGroupMoveHandler

(

string

formationType

)

GetAgentMoveHandlerId()

proto external int AIGroupMovementComponent.GetAgentMoveHandlerId

(

notnull AIAgent

agent

)

Group Movement Handler: Takes care of planning movement and organizing in formation a collection of agents in a group.

Default handler 0 is initialized with the formation specified in 'DefaultFormation' variable. Contains all agents of the group unless moved. Can't be removed. With additional handlers, it's possible to subdivide the group into independent moving parts. Example: Part of the group organized in a vehicle convoy. Additional handlers need to be created and removed manually.

GetAgentsInHandler()

proto int AIGroupMovementComponent.GetAgentsInHandler	(	notnull out array< AIAgent >	outAgents,
		int	handlerId = 0
	)

GetFormationDefinition()

proto external AIFormationDefinition AIGroupMovementComponent.GetFormationDefinition

(

int

handlerId

)

GetFormationDisplacement()

proto external int AIGroupMovementComponent.GetFormationDisplacement

(

int

handlerId = 0

)

GetGroupCharactersMovementTypeWanted()

proto external EMovementType AIGroupMovementComponent.GetGroupCharactersMovementTypeWanted

(

)

GetHandlerLeaderAgent()

proto AIAgent AIGroupMovementComponent.GetHandlerLeaderAgent

(

int

handlerId = 0

)

GetMoveHandlerAgentCount()

proto external int AIGroupMovementComponent.GetMoveHandlerAgentCount

(

int

handlerId = 0

)

IsFormationDisplaced()

proto external bool AIGroupMovementComponent.IsFormationDisplaced

(

int

handlerId = 0

)

MoveAgentToHandler()

proto external void AIGroupMovementComponent.MoveAgentToHandler	(	notnull AIAgent	agent,
		int	originalHandlerId,
		int	newHandlerId
	)

OnMoveHandlerAdded()

void AIGroupMovementComponent.OnMoveHandlerAdded

(

int

handlerId

)

OnMoveHandlerRemoved()

void AIGroupMovementComponent.OnMoveHandlerRemoved

(

int

handlerId

)

RemoveGroupMoveHandler()

proto external void AIGroupMovementComponent.RemoveGroupMoveHandler

(

int

handlerId

)

SetFormationDefinition()

proto external bool AIGroupMovementComponent.SetFormationDefinition	(	int	handlerId,
		string	formation
	)

SetFormationDisplacement()

proto external void AIGroupMovementComponent.SetFormationDisplacement	(	int	iValue,
		int	handlerId = 0
	)

Displacement modifies formation indexes.

Examples: Displacement = 0, Used formation indexes: 0, 1, ..., Max Displacement = 2, Used formation indexes: 2, 3, ..., Max

SetGroupCharactersWantedMovementType()

proto external void AIGroupMovementComponent.SetGroupCharactersWantedMovementType

(

EMovementType

movementWanted

)

SetMoveHandlerLeader()

proto external void AIGroupMovementComponent.SetMoveHandlerLeader	(	notnull AIAgent	agent,
		int	originalHandlerId,
		int	newHandlerId
	)

Member Data Documentation

DEFAULT_HANDLER_ID

const int AIGroupMovementComponent.DEFAULT_HANDLER_ID = 0

static

---

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

• Game/generated/AI/AIGroupMovementComponent.c