AIGroupMovementComponent.c

Go to the documentation of this file.

/*
===========================================
Do not modify, this script is generated
===========================================
*/

 
class AIGroupMovementComponentClass: AIBaseMovementComponentClass
{
}
 
class AIGroupMovementComponent: AIBaseMovementComponent
{
    const int DEFAULT_HANDLER_ID = 0;
 
    proto external void SetGroupCharactersWantedMovementType(EMovementType movementWanted);
    proto external EMovementType GetGroupCharactersMovementTypeWanted();
    proto external int GetAgentMoveHandlerId(notnull AIAgent agent);
    //Creates empty group move handler and returns it's identification
    proto external int CreateGroupMoveHandler(string formationType);
    //Returns how many agents there's in a handler and -1 if the handler doesn't exists.
    proto external int GetMoveHandlerAgentCount(int handlerId = 0);
    //Moves individual agent from one handler to another
    proto external void MoveAgentToHandler(notnull AIAgent agent, int originalHandlerId, int newHandlerId);
    //Moves individual agent from one handler to another and makes it the leader of the formation
    proto external void SetMoveHandlerLeader(notnull AIAgent agent, int originalHandlerId, int newHandlerId);
    //Removes the indicated group move handler. All it's agents go back to the default handler.
    proto external void RemoveGroupMoveHandler(int handlerId);
    //Removes all existing handlers. All agents go back to the default handler.
    proto external void ClearGroupMoveHandlers();
    //Formations getters and setters
    proto external bool SetFormationDefinition(int handlerId, string formation);
    proto external AIFormationDefinition GetFormationDefinition(int handlerId);
    proto external void SetFormationDisplacement(int iValue, int handlerId = 0);
    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);
 
    // callbacks
 
    event void OnMoveHandlerAdded(int handlerId);
    event void OnMoveHandlerRemoved(int handlerId);
}