Squad

Members

Member	Description
`attackTarget`	Squadmates will always prioritize firing at their squad’s attackTarget if they are able to.
`autoDropTransportedPassengers`	When set to true while in transport vehicle, will automatically drop passengers when close to attack point destination.
`claimedLandingZone`
`hasLanded`	Returns true if the squad has landed their helicopter.
`hasLandingZoneClaim`
`hasPlayerLeader`
`isPerformingLanding`	Returns true if the squad is performing a landing or has landed a helicopter.
`leader`	The current leader of this squad.
`members`	The current members of this squad.
`order`	The current order assigned to this squad.
`squadVehicle`	Get the vehicle claimed by this squad.

Event	Description
`onIssueOrderMovement`	Invoked whenever the squad leader wants to go to the order objective.

Method	Description
`AddMember(newMember)`	Assign a new member to this squad.
`AssignOrder(order)`	Assigns a new order to this squad.
`CancelLanding()`	Cancels a landing.
`ClaimLandingZone(lz)`	Claims the LZ
`DropTransportedPassengers()`	Drops all transported passengers
`LandHelicopterAndClaimLandingZone(lz)`	Lands at LZ and claims it
`LandHelicopterAndClaimLandingZone(lz, onLandFunctionName)`	Lands at LZ and claims it and calls function when landing completes.
`LandHelicopterAtPosition(position)`	Lands at position.
`LandHelicopterAtPosition(position, onLandFunctionName)`	Lands at position and calls function when landing completes.
`LandHelicopterAtPosition(position, onLandFunctionName, eventData)`	Lands at position and calls function when landing completes.
`ReleaseLandingZoneClaim()`	Drops the squade’s current LZ claim.
`RemoveMember(member)`	Removes a member from this squad.
`SetCustomFormation(formation)`	Set the formation to a specified custom formation.
`SetFormation(formation)`
`SetFormationSize(formationWidth, formationDepth)`
`SetRandomFormation()`	Set a random formation, excluding custom formation.
`SplitSquad(count)`	Removes a number of actors from this squad.
`SplitSquad(membersToDrop)`	Removes the specified actors from this squad.
`TakeOff()`	Cancels a landing and takes off.
`ToString()`

Method	Description
`Create(actors)`	Creates a new squad with the specified actors.

class Squad

Actor attackTarget: Squadmates will always prioritize firing at their squad’s attackTarget if they are able to. Attack targets always override the current rules-of-engagement. If the attack target dies, this value will automatically be set to nil.

bool autoDropTransportedPassengers: When set to true while in transport vehicle, will automatically drop passengers when close to attack point destination.

const bool hasLanded: Returns true if the squad has landed their helicopter.

const bool isPerformingLanding: Returns true if the squad is performing a landing or has landed a helicopter. Also see hasLanded.

const ScriptEvent onIssueOrderMovement

Callback Signature:

Note

This event can be consumed by calling CurrentEvent.Consume(). Consume this event to prevent the default squad leader movement

Invoked whenever the squad leader wants to go to the order objective.

void ClaimLandingZone(HelicopterLandingZone lz): Claims the LZ Any claimed landing zones will not be used by other squads.

array<AiActorController> DropTransportedPassengers(): Drops all transported passengers Any passengers on mounted weapons will stay in the vehicle. Returns the dropped passengers.

void LandHelicopterAndClaimLandingZone(HelicopterLandingZone lz): Lands at LZ and claims it Any claimed landing zones will not be used by other squads.

void LandHelicopterAndClaimLandingZone(HelicopterLandingZone lz, string onLandFunctionName): Lands at LZ and claims it and calls function when landing completes. Any claimed landing zones will not be used by other squads. Callback function signature: OnLand(squad, eventData)

void LandHelicopterAtPosition(Vector3 position, string onLandFunctionName): Lands at position and calls function when landing completes. Callback function signature: OnLand(squad, eventData)

void LandHelicopterAtPosition(Vector3 position, string onLandFunctionName, DynValue eventData): Lands at position and calls function when landing completes. Callback function signature: OnLand(squad, eventData)

void ReleaseLandingZoneClaim(): Drops the squade’s current LZ claim. This is automatically done when the squad is disbanded.

void SetCustomFormation(array<Vector2> formation): Set the formation to a specified custom formation. The formation data contains the location of each squad member, which is rotated according to the squad movement direction and scaled by the formationWidth and formationHeight values. You can safely provide a greater number of locations than the current member count, which will be automatically used if more soldiers join the squad.

void SetRandomFormation(): Set a random formation, excluding custom formation.

Squad SplitSquad(int count): Removes a number of actors from this squad. The removed actors will form their own squad. Returns the new squad.

Squad SplitSquad(array<Actor> membersToDrop): Removes the specified actors from this squad. The removed actors will form their own squad. Returns the new squad.

static Squad Create(array<Actor> actors): Creates a new squad with the specified actors. NOTE: The Player actor will be ignored, you can populate the player squad by adding members to Player.squad