Close ×

AI.AI_A2A_Cap

AI - Models the process of Combat Air Patrol (CAP) for airplanes.
AI.AI_A2A_Dispatcher

AI - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
AI.AI_A2A_Gci

AI - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI - Models the process of air patrol of airplanes.
AI.AI_A2G_BAI

AI - Models the process of air to ground BAI engagement for airplanes and helicopters.
AI.AI_A2G_CAS

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_A2G_Dispatcher

AI - Create an automated A2G defense system with reconnaissance units, coordinating SEAD, BAI and CAS operations.
AI.AI_A2G_SEAD

AI - Models the process of air to ground SEAD engagement for airplanes and helicopters.
AI.AI_Air

AI - Models the process of AI air operations.
AI.AI_Air_Dispatcher

AI - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP operations.
AI.AI_Air_Engage

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_Air_Patrol

AI - Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.
AI.AI_BAI

AI - Peform Battlefield Area Interdiction (BAI) within an engagement zone.
AI.AI_Balancer

AI - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.
AI.AI_CAP

AI - Perform Combat Air Patrolling (CAP) for airplanes.
AI.AI_CAS

AI - Perform Close Air Support (CAS) near friendlies.
AI.AI_Cargo

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI - Models the intelligent transportation of cargo using ground vehicles.
AI.AI_Cargo_Airplane

AI - Models the intelligent transportation of cargo using airplanes.
AI.AI_Cargo_Dispatcher

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

AI - Models the intelligent transportation of infantry and other cargo using APCs.
AI.AI_Cargo_Dispatcher_Airplane

AI - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Dispatcher_Ship

AI - Models the intelligent transportation of infantry and other cargo using Ships.
AI.AI_Cargo_Helicopter

AI - Models the intelligent transportation of cargo using helicopters.
AI.AI_Cargo_Ship

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Escort

AI - Taking the lead of AI escorting your flight or of other AI.
AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.
AI.AI_Escort_Dispatcher_Request

AI - Models the assignment of AI escorts to player flights upon request using the radio menu.
AI.AI_Escort_Request

AI - Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
AI.AI_Formation

AI - Build large airborne formations of aircraft.
AI.AI_Patrol

AI - Perform Air Patrolling for airplanes.
Actions.Act_Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occurring on UNITs.
Actions.Act_Assign

(SP) (MP) (FSM) Accept or reject process for player (task) assignments.
Actions.Act_Assist

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Actions.Act_Route

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Cargo.Cargo

Cargo - Management of CARGO logistics, that can be transported from and to transportation carriers.
Cargo.CargoCrate

Cargo - Management of single cargo crates, which are based on a STATIC object.
Cargo.CargoGroup

Cargo - Management of grouped cargo logistics, which are based on a GROUP object.
Cargo.CargoSlingload

Cargo - Management of single cargo crates, which are based on a STATIC object.
Cargo.CargoUnit

Cargo - Management of single cargo logistics, which are based on a UNIT object.
Core.Astar

Core - A* Pathfinding.
Core.Base

Core - The base class within the framework.
Core.Beacon

Core - TACAN and other beacons.
Core.ClientMenu

Core - Client Menu Management.
Core.Condition

Core - Define any or all conditions to be evaluated.
Core.Database

Core - Manages several databases containing templates, mission objects, and mission information.
Core.Event

Core - Models DCS event dispatching using a publish-subscribe model.
Core.Fsm

Core - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
Core.Goal

Core - Models the process to achieve goal(s).
Core.MarkerOps_Base

Core - Tap into markers added to the F10 map by users.
Core.Menu

Core - Manage hierarchical menu structures and commands for players within a mission.
Core.Message

Core - Informs the players using messages during a simulation.
Core.Pathline

Core - Path from A to B.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
Core.Report

Core - Provides a handy means to create messages and reports.
Core.ScheduleDispatcher

Core - SCHEDULEDISPATCHER dispatches the different schedules.
Core.Scheduler

Core - Prepares and handles the execution of functions over scheduled time (intervals).
Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.
Core.Settings

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.
Core.Spawn

Core - Spawn dynamically new groups of units in running missions.
Core.SpawnStatic

Core - Spawn statics.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
Core.TextAndSound

Core - A Moose GetText system.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.
Core.Zone

Core - Define zones within your mission of various forms, with various capabilities.
Core.Zone_Detection

Core - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
DCS

DCS API Prototypes.
Functional.AICSAR

Functional - AI CSAR system.
Functional.ATC_Ground

Functional - Monitor airbase traffic and regulate speed while taxiing.
Functional.AmmoTruck

Functional -- Send a truck to supply artillery groups.
Functional.Artillery

Functional - Control artillery units.
Functional.Autolase

Functional - Autolase targets in the field.
Functional.CleanUp

Functional - Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
Functional.Designate

Functional - Management of target Designation.
Functional.Detection

Functional - Models the detection of enemy units by FACs or RECCEs and group them according various methods.
Functional.DetectionZones

Functional - Captures the class DETECTION_ZONES.
Functional.Escort

Functional - Taking the lead of AI escorting your flight.
Functional.Fox

Functional - Yet Another Missile Trainer.
Functional.Mantis

Functional - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.
Functional.MissileTrainer

Functional - Train missile defence and deflection.
Functional.Movement

Functional - Limit the movement of simulaneous moving ground vehicles.
Functional.PseudoATC

Functional - Basic ATC.
Functional.RAT

Functional - Create random airtraffic in your missions.
Functional.Range

Functional - Range Practice.
Functional.Scoring

Functional - Administer the scoring of player achievements, file and log the scoring events for use at websites.
Functional.Sead

Functional - Make SAM sites evasive and execute defensive behaviour when being fired upon.
Functional.Shorad

Functional - Short Range Air Defense System.
Functional.Stratego

Functional - Stratego.
Functional.Suppression

Functional - Suppress fire of ground units when they get hit.
Functional.Tiresias

Functional - TIRESIAS - manages AI behaviour.
Functional.Warehouse

Functional - Simulation of logistic operations.
Functional.ZoneCaptureCoalition

Functional - Models the process to zone guarding and capturing.
Functional.ZoneGoal

Functional - Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

Functional - Base class that models processes to achieve goals involving a Zone and Cargo.
Functional.ZoneGoalCoalition

Functional (WIP) - Base class modeling processes to achieve goals involving coalition zones.
OPS.FlightControl

OPS - Air Traffic Control for AI and human players.
Ops.ATIS


Ops.AWACS

Ops - MOOSE AI AWACS Operations using text-to-speech.
Ops.Airboss

Ops - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).
Ops.Airwing

Ops - Airwing Warehouse.
Ops.ArmyGroup

Ops - Enhanced Ground Group.
Ops.Auftrag


Ops.Brigade

Ops - Brigade Warehouse.
Ops.CSAR

Ops - Combat Search and Rescue.
Ops.CTLD

Ops - Combat Troops & Logistics Department.
Ops.Chief

Ops - Chief of Staff.
Ops.Cohort

Ops - Cohort encompassed all characteristics of SQUADRONs, PLATOONs and FLOTILLAs.
Ops.Commander

Ops - Commander of Airwings, Brigades and Fleets.
Ops.EasyGCICAP

Easy CAP/GCI Class, based on OPS classesDocumentation
https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Ops.EasyGCICAP.html
Date: September 2023Ops - Easy GCI & CAP Manager
Main Features:
Automatically create and manage A2A CAP/GCI defenses using an AirWing and Squadrons for one coalition
Easy set-up
Add additional AirWings on other airbases
Each wing can have more than one Squadron - tasking to Squadrons is done on a random basis per AirWing
Create borders and zones of engagement
Detection can be ground based and/or via AWACS
AUTHOR: applevangelist
Ops.Fleet

Ops - Fleet Warehouse.
Ops.FlightGroup

Ops - Enhanced Airborne Group.
Ops.Flotilla

Ops - Flotilla is a small naval group belonging to a fleet.
Ops.Intel

Ops - Office of Military Intelligence.
Ops.Legion

Ops - Legion Warehouse.
Ops.NavyGroup

Ops - Enhanced Naval Group.
Ops.Operation

Ops - Operation with multiple phases.
Ops.OpsGroup

Ops - Generic group enhancement.
Ops.OpsTransport

Ops - Transport assignment for OPS groups and storage.
Ops.OpsZone

Ops - Strategic Zone.
Ops.Platoon

Ops - Brigade Platoon.
Ops.PlayerRecce

Ops - Allow a player in a helo like the Gazelle, KA-50 to recon and lase ground targets.
Ops.PlayerTask

Ops - PlayerTask (mission) for Players.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Ops.Squadron

Ops - Airwing Squadron.
Ops.Target

Ops - Target.
Shapes.CUBE


Author: nielsvaes/coconutcockpit
Shapes.LINE


Author: nielsvaes/coconutcockpit
Shapes.OVAL


Author: nielsvaes/coconutcockpit
Shapes.POLYGON


Author: nielsvaes/coconutcockpit
Shapes.SHAPE_BASE

Shapes - Class that serves as the base shapes drawn in the Mission Editor
Author: nielsvaes/coconutcockpit
Shapes.TRIANGLE

TRIANGLE class with properties and methods for handling triangles.
Sound.Radio

Sound - Radio transmissions.
Sound.RadioQueue

Sound - Queues Radio Transmissions.
Sound.RadioSpeech

Core - Makes the radio talk.
Sound.SRS

Sound - Simple Radio Standalone (SRS) Integration and Text-to-Speech.
Sound.SoundOutput

Sound - Sound output classes.
Sound.UserSound

Sound - Manage user sound.
Tasking.CommandCenter

Tasking - A command center governs multiple missions, and takes care of the reporting and communications.
Tasking.DetectionManager

Tasking - This module contains the DETECTION_MANAGER class and derived classes.
Tasking.Mission

Tasking - A mission models a goal to be achieved through the execution and completion of tasks by human players.
Tasking.Task

Tasking - A task object governs the main engine to administer human taskings.
Tasking.TaskInfo

Tasking - Controls the information of a Task.
Tasking.Task_A2A

Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Tasking.Task_A2A_Dispatcher

Tasking - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
Tasking.Task_A2G

Tasking - The TASK_A2G models tasks for players in Air to Ground engagements.
Tasking.Task_A2G_Dispatcher

Tasking - Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.
Tasking.Task_CARGO

Tasking - Base class to model tasks for players to transport cargo.
Tasking.Task_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Tasking.Task_Capture_Zone

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
Tasking.Task_Cargo_CSAR

Tasking - Orchestrates the task for players to execute CSAR for downed pilots.
Tasking.Task_Cargo_Dispatcher

Tasking - Creates and manages player TASK_CARGO tasks.
Tasking.Task_Cargo_Transport

Tasking - Models tasks for players to transport cargo.
Tasking.Task_Manager

Tasking - This module contains the TASK_MANAGER class and derived classes.
Utilities.Enums

Utilities Enumerators.
Utilities.FiFo

 UTILS - Classic FiFo Stack.
Utilities.Profiler

Utils - Lua Profiler.
Utilities.STTS

Utilities  - DCS Simple Text-To-Speech (STTS).
Utilities.Socket

Utilities - Socket.
Utilities.Templates

Utilities - Templates.
Utilities.Utils

Utilities - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.
Wrapper.Airbase

Wrapper - AIRBASE is a wrapper class to handle the DCS Airbase objects.
Wrapper.Client

Wrapper - CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.
Wrapper.Controllable

Wrapper - CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
Wrapper.Group

Wrapper - GROUP wraps the DCS Class Group objects.
Wrapper.Identifiable

Wrapper - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
Wrapper.Marker

Wrapper - Markers On the F10 map.
Wrapper.Net

Wrapper - DCS net functions.
Wrapper.Object

Wrapper - OBJECT wraps the DCS Object derived objects.
Wrapper.Positionable

Wrapper - POSITIONABLE wraps DCS classes that are "positionable".
Wrapper.Scenery

Wrapper - SCENERY models scenery within the DCS simulator.
Wrapper.Static

Wrapper - STATIC wraps the DCS StaticObject class.
Wrapper.Storage

Wrapper - Warehouse storage of DCS airbases.
Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.
Wrapper.Weapon

Wrapper - Weapon functions.

Module AI.AI_Cargo_APC

AI - Models the intelligent transportation of cargo using ground vehicles.

Author: FlightControl

Global(s)

Global AI_CARGO_APC

Brings a dynamic cargo handling capability for an AI vehicle group.

#AI_CARGO_APC AI_CARGO_APC

Brings a dynamic cargo handling capability for an AI vehicle group.

Armoured Personnel Carriers (APC), Trucks, Jeeps and other ground based carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation.

The AI_CARGO_APC class uses the Cargo.Cargo capabilities within the MOOSE framework. Cargo.Cargo must be declared within the mission to make the AI_CARGO_APC object recognize the cargo. Please consult the Cargo.Cargo module for more information.

Cargo loading.

The module will load automatically cargo when the APCs are within boarding or loading radius. The boarding or loading radius is specified when the cargo is created in the simulation, and therefore, this radius depends on the type of cargo and the specified boarding radius.

Defending the APCs when enemies nearby.

Cargo will defend the carrier with its available arms, and to avoid cargo being lost within the battlefield.

When the APCs are approaching enemy units, something special is happening. The APCs will stop moving, and the loaded infantry will unboard and follow the APCs and will help to defend the group. The carrier will hold the route once the unboarded infantry is further than 50 meters from the APCs, to ensure that the APCs are not too far away from the following running infantry. Once all enemies are cleared, the infantry will board again automatically into the APCs. Once boarded, the APCs will follow its pre-defined route.

A combat radius needs to be specified in meters at the AI_CARGO_APC.New() method. This combat radius will trigger the unboarding of troops when enemies are within the combat radius around the APCs. During my tests, I've noticed that there is a balance between ensuring that the infantry is within sufficient hit radius (effectiveness) versus vulnerability of the infantry. It all depends on the kind of enemies that are expected to be encountered. A combat radius of 350 meters to 500 meters has been proven to be the most effective and efficient.

However, when the defense of the carrier, is not required, it must be switched off. This is done by disabling the defense of the carrier using the method AI_CARGO_APC.SetCombatRadius(), and providing a combat radius of 0 meters. It can be switched on later when required by reenabling the defense using the method and providing a combat radius larger than 0.

Infantry or cargo health.

When infantry is unboarded from the APCs, the infantry is actually respawned into the battlefield. As a result, the unboarding infantry is very healthy every time it unboards. This is due to the limitation of the DCS simulator, which is not able to specify the health of new spawned units as a parameter. However, infantry that was destroyed when unboarded and following the APCs, won't be respawned again. Destroyed is destroyed. As a result, there is some additional strength that is gained when an unboarding action happens, but in terms of simulation balance this has marginal impact on the overall battlefield simulation. Fortunately, the firing strength of infantry is limited, and thus, respacing healthy infantry every time is not so much of an issue ...

Control the APCs on the map.

It is possible also as a human ground commander to influence the path of the APCs, by pointing a new path using the DCS user interface on the map. In this case, the APCs will change the direction towards its new indicated route. However, there is a catch! Once the APCs are near the enemy, and infantry is unboarded, the APCs won't be able to hold the route until the infantry could catch up. The APCs will simply drive on and won't stop! This is a limitation in ED that prevents user actions being controlled by the scripting engine. No workaround is possible on this.

Cargo deployment.

Using the AI_CARGO_APC.Deploy() method, you are able to direct the APCs towards a point on the battlefield to unboard/unload the cargo at the specific coordinate. The APCs will follow nearby roads as much as possible, to ensure fast and clean cargo transportation between the objects and villages in the simulation environment.

Cargo pickup.

Using the AI_CARGO_APC.Pickup() method, you are able to direct the APCs towards a point on the battlefield to board/load the cargo at the specific coordinate. The APCs will follow nearby roads as much as possible, to ensure fast and clean cargo transportation between the objects and villages in the simulation environment.

Developer Note

Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated

Type(s)

Type AI_CARGO_APC

AI_CARGO_APC , extends AI.AI_Cargo#AI_CARGO

Fields and Methods inherited from AI_CARGO_APC	Description
AI_CARGO_APC.CargoCarrier
AI_CARGO_APC.CarrierCoordinate
AI_CARGO_APC.CarrierStopped
AI_CARGO_APC.Coalition
AI_CARGO_APC.CombatRadius
AI_CARGO_APC:FindCarrier(Coordinate, Radius)	Find a free Carrier within a radius.
AI_CARGO_APC:FollowToCarrier(Me, APCUnit, Cargo, CargoGroup)	Follow Infantry to the Carrier.
AI_CARGO_APC:New(APC, CargoSet, CombatRadius)	Creates a new AI_CARGO_APC object.
AI_CARGO_APC.RouteDeploy
AI_CARGO_APC.RouteHome
AI_CARGO_APC.RoutePickup
AI_CARGO_APC:SetCarrier(CargoCarrier)	Set the Carrier.
AI_CARGO_APC:SetCombatRadius(CombatRadius)	Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).
AI_CARGO_APC:SetDeployOffRoad(Offroad, Formation)	Set whether the carrier will not use roads to deploy the cargo.
AI_CARGO_APC:SetOffRoad(Offroad, Formation)	Set whether or not the carrier will use roads to pickup and deploy the cargo.
AI_CARGO_APC:SetPickupOffRoad(Offroad, Formation)	Set whether the carrier will not use roads to pickup the cargo.
AI_CARGO_APC.Zone
AI_CARGO_APC._Deploy(APC, self, Coordinate, DeployZone)	Deploy task function.
AI_CARGO_APC._Pickup(APC, sel, Coordinate, Speed, PickupZone, self)	Pickup task function.
AI_CARGO_APC.deployFormation
AI_CARGO_APC.deployOffroad
AI_CARGO_APC:onafterDeploy(APC, From, Event, To, Coordinate, Speed, Height, DeployZone)	On after Deploy event.
AI_CARGO_APC:onafterDeployed(Carrier, From, Event, To, DeployZone, APC, Defend)	On after Deployed event.
AI_CARGO_APC:onafterFollow(APC, From, Event, To)	On after Follow event.
AI_CARGO_APC:onafterHome(APC, From, Event, To, Coordinate, Speed, Height, HomeZone)	On after Home event.
AI_CARGO_APC:onafterMonitor(APC, From, Event, To)	On after Monitor event.
AI_CARGO_APC:onafterPickup(APC, From, Event, To, Coordinate, Speed, Height, PickupZone)	On after Pickup event.
AI_CARGO_APC:onafterUnloaded(Carrier, From, Event, To, Cargo, Deployed, DeployZone, CarrierUnit, Defend)	On after Unloaded event.
AI_CARGO_APC.pickupFormation
AI_CARGO_APC.pickupOffroad

Fields and Methods inherited from AI_CARGO	Description
AI_CARGO_APC.CargoCarrier
AI_CARGO_APC.CargoSet
AI_CARGO_APC.Carrier_Cargo
AI_CARGO_APC:Deploy(Coordinate, Speed)	Deploy Trigger for AI_CARGO
AI_CARGO_APC:IsRelocating()
AI_CARGO_APC:IsTransporting()
AI_CARGO_APC:New(Carrier, CargoSet)	Creates a new AI_CARGO object.
AI_CARGO_APC:OnAfterDeploy(From, Event, To, Coordinate, Speed)	Deploy Handler OnAfter for AI_CARGO
AI_CARGO_APC:OnAfterDeployed(Carrier, From, Event, To, DeployZone, Defend)	On after Deployed event.
AI_CARGO_APC:OnAfterLoaded(Carrier, From, Event, To)	Loaded Handler OnAfter for AI_CARGO
AI_CARGO_APC:OnAfterPickup(From, Event, To, Coordinate, Speed)	Pickup Handler OnAfter for AI_CARGO
AI_CARGO_APC:OnAfterUnloaded(Carrier, From, Event, To)	Unloaded Handler OnAfter for AI_CARGO
AI_CARGO_APC:OnBeforeDeploy(From, Event, To, Coordinate, Speed)	Deploy Handler OnBefore for AI_CARGO
AI_CARGO_APC:OnBeforePickup(From, Event, To, Coordinate, Speed)	Pickup Handler OnBefore for AI_CARGO
AI_CARGO_APC:Pickup(Coordinate, Speed)	Pickup Trigger for AI_CARGO
AI_CARGO_APC.Relocating
AI_CARGO_APC.Transporting
AI_CARGO_APC:__Deploy(Delay, Coordinate, Speed)	Deploy Asynchronous Trigger for AI_CARGO
AI_CARGO_APC:__Pickup(Delay, Coordinate, Speed)	Pickup Asynchronous Trigger for AI_CARGO
AI_CARGO_APC:onafterBoard(Carrier, From, Event, To, Cargo, CarrierUnit, PickupZone)	On after Board event.
AI_CARGO_APC:onafterDeploy(APC, From, Event, To, Coordinate, Speed, Height, DeployZone)	On after Deploy event.
AI_CARGO_APC:onafterDeployed(Carrier, From, Event, To, DeployZone, Defend)	On after Deployed event.
AI_CARGO_APC:onafterLoaded(Carrier, From, Event, To, PickupZone, Cargo)	On after Loaded event.
AI_CARGO_APC:onafterPickedUp(Carrier, From, Event, To, PickupZone)	On after PickedUp event.
AI_CARGO_APC:onafterPickup(APC, From, Event, To, Coordinate, Speed, Height, PickupZone)	On after Pickup event.
AI_CARGO_APC:onafterUnboard(Carrier, From, Event, To, Cargo, DeployZone, CarrierUnit, Defend)	On after Unboard event.
AI_CARGO_APC:onafterUnload(Carrier, From, Event, To, DeployZone, Defend)	On after Unload event.
AI_CARGO_APC:onafterUnloaded(Carrier, From, Event, To, Cargo, Deployed, DeployZone, CarrierUnit, Defend)	On after Unloaded event.
AI_CARGO_APC:onbeforeLoad(Carrier, From, Event, To, PickupZone)	On before Load event.
AI_CARGO_APC:onbeforeReload(Carrier, From, Event, To, PickupZone)	On before Reload event.

Type AI.AI_Cargo_APC

Type AI_CARGO_APC

Field(s)

Wrapper.Group#GROUP AI_CARGO_APC.CargoCarrier

AI_CARGO_APC.CarrierCoordinate

#boolean AI_CARGO_APC.CarrierStopped

AI_CARGO_APC.Coalition

#boolean AI_CARGO_APC.RouteDeploy

#boolean AI_CARGO_APC.RouteHome

#boolean AI_CARGO_APC.RoutePickup

AI_CARGO_APC.Zone

AI_CARGO_APC.deployOffroad

AI_CARGO_APC.pickupOffroad

Function(s)

AI_CARGO_APC:FindCarrier(Coordinate, Radius)

Find a free Carrier within a radius.

Defined in:

AI_CARGO_APC

Parameters:

Core.Point#COORDINATE Coordinate

#number Radius

Return value:

Wrapper.Group#GROUP:

NewCarrier

AI_CARGO_APC:FollowToCarrier(Me, APCUnit, Cargo, CargoGroup)

Follow Infantry to the Carrier.

Defined in:

AI_CARGO_APC

Parameters:

#AI_CARGO_APC Me

Wrapper.Unit#UNIT APCUnit

Cargo.CargoGroup#CARGO_GROUP Cargo

CargoGroup

Return value:

#AI_CARGO_APC:

AI_CARGO_APC:New(APC, CargoSet, CombatRadius)

Creates a new AI_CARGO_APC object.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

The carrier APC group.

Core.Set#SET_CARGO CargoSet

The set of cargo to be transported.

#number CombatRadius

Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby. When the combat radius is 0, no defense will happen of the carrier.

Return value:

#AI_CARGO_APC:

AI_CARGO_APC:SetCarrier(CargoCarrier)

Set the Carrier.

Defined in:

AI_CARGO_APC

Parameter:

Wrapper.Group#GROUP CargoCarrier

Return value:

#AI_CARGO_APC:

AI_CARGO_APC:SetCombatRadius(CombatRadius)

Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).

This is only valid for APCs and trucks etc, thus ground vehicles.

Defined in:

AI_CARGO_APC

Parameter:

#number CombatRadius

Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby. When the combat radius is 0, no defense will happen of the carrier. When the combat radius is not provided, no defense will happen!

Return value:

#AI_CARGO_APC:

Usage:


-- Disembark the infantry when the carrier is under attack.
AICargoAPC:SetCombatRadius( true )

-- Keep the cargo in the carrier when the carrier is under attack.
AICargoAPC:SetCombatRadius( false )

AI_CARGO_APC:SetDeployOffRoad(Offroad, Formation)

Set whether the carrier will not use roads to deploy the cargo.

Defined in:

AI_CARGO_APC

Parameters:

#boolean Offroad

If true, carrier will not use roads.

#number Formation

Offroad formation used. Default is ENUMS.Formation.Vehicle.Offroad.

Return value:

#AI_CARGO_APC:

self

AI_CARGO_APC:SetOffRoad(Offroad, Formation)

Set whether or not the carrier will use roads to pickup and deploy the cargo.

Defined in:

AI_CARGO_APC

Parameters:

#boolean Offroad

If true, carrier will not use roads. If nil or false the carrier will use roads when available.

#number Formation

Offroad formation used. Default is ENUMS.Formation.Vehicle.Offroad.

Return value:

#AI_CARGO_APC:

self

AI_CARGO_APC:SetPickupOffRoad(Offroad, Formation)

Set whether the carrier will not use roads to pickup the cargo.

Defined in:

AI_CARGO_APC

Parameters:

#boolean Offroad

If true, carrier will not use roads.

#number Formation

Offroad formation used. Default is ENUMS.Formation.Vehicle.Offroad.

Return value:

#AI_CARGO_APC:

self

AI_CARGO_APC._Deploy(APC, self, Coordinate, DeployZone)

Deploy task function.

Triggers Unload event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

The cargo carrier group.

#AI_CARGO_APC self

AI_CARGO_APC class.

Core.Point#COORDINATE Coordinate

The coordinate (not used).

Core.Zone#ZONE DeployZone

Deploy zone.

AI_CARGO_APC._Pickup(APC, sel, Coordinate, Speed, PickupZone, self)

Pickup task function.

Triggers Load event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

The cargo carrier group.

#AI_CARGO_APC sel

AI_CARGO_APC class.

Core.Point#COORDINATE Coordinate

The coordinate (not used).

#number Speed

Speed (not used).

Core.Zone#ZONE PickupZone

Pickup zone.

self

AI_CARGO_APC:onafterDeploy(APC, From, Event, To, Coordinate, Speed, Height, DeployZone)

On after Deploy event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

From

Event

Core.Point#COORDINATE Coordinate

Deploy place.

#number Speed

Speed in km/h to drive to the depoly coordinate. Default is 50% of max possible speed the unit can go.

#number Height

Height in meters to move to the deploy coordinate. This parameter is ignored for APCs.

Core.Zone#ZONE DeployZone

The zone where the cargo will be deployed.

AI_CARGO_APC:onafterDeployed(Carrier, From, Event, To, DeployZone, APC, Defend)

On after Deployed event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP Carrier

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE DeployZone

The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

APC

Defend

AI_CARGO_APC:onafterFollow(APC, From, Event, To)

On after Follow event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

#string From

From state.

#string Event

Event.

#string To

To state.

AI_CARGO_APC:onafterHome(APC, From, Event, To, Coordinate, Speed, Height, HomeZone)

On after Home event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

From

Event

Core.Point#COORDINATE Coordinate

Home place.

#number Speed

Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.

#number Height

Height in meters to move to the home coordinate. This parameter is ignored for APCs.

HomeZone

AI_CARGO_APC:onafterMonitor(APC, From, Event, To)

On after Monitor event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

#string From

From state.

#string Event

Event.

#string To

To state.

AI_CARGO_APC:onafterPickup(APC, From, Event, To, Coordinate, Speed, Height, PickupZone)

On after Pickup event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP APC

From

Event

Core.Point#COORDINATE Coordinate

of the pickup point.

#number Speed

Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.

#number Height

Height in meters to move to the pickup coordinate. This parameter is ignored for APCs.

Core.Zone#ZONE PickupZone

(optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.

AI_CARGO_APC:onafterUnloaded(Carrier, From, Event, To, Cargo, Deployed, DeployZone, CarrierUnit, Defend)

On after Unloaded event.

Defined in:

AI_CARGO_APC

Parameters:

Wrapper.Group#GROUP Carrier

#string From

From state.

#string Event

Event.

#string To

To state.

#string Cargo

Cargo#CARGO Cargo Cargo object.

#boolean Deployed

Cargo is deployed.

Core.Zone#ZONE DeployZone

The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

CarrierUnit

Defend

Field(s)

Wrapper.Group#GROUP AI_CARGO_APC.CargoCarrier

AI_CARGO_APC.CarrierCoordinate

#boolean AI_CARGO_APC.CarrierStopped

AI_CARGO_APC.Coalition

#boolean AI_CARGO_APC.RouteDeploy

#boolean AI_CARGO_APC.RouteHome

#boolean AI_CARGO_APC.RoutePickup

AI_CARGO_APC.Zone

AI_CARGO_APC.deployOffroad

AI_CARGO_APC.pickupOffroad

Function(s)

AI_CARGO_APC:Deploy(Coordinate, Speed)

Deploy Trigger for AI_CARGO