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.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.ATC_Ground

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

Functional - Control artillery units.
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.Suppression

Functional - Suppress fire of ground units when they get hit.
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 - Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.ATIS


Ops.Airboss

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

Ops - Combat Search and Rescue.
Ops.CTLD

Ops - Combat Troops & Logistics Department.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
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 Cargo.CargoGroup

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

Author: FlightControl

Contributions:

Global(s)

Global CARGO_GROUP

Defines a cargo that is represented by a Wrapper.Group object within the simulator.

#CARGO_GROUP CARGO_GROUP

Defines a cargo that is represented by a Wrapper.Group object within the simulator.

The cargo can be Loaded, UnLoaded, Boarded, UnBoarded to and from Carriers.

The above cargo classes are used by the following AI_CARGO_ classes to allow AI groups to transport cargo:

AI Armoured Personnel Carriers to transport cargo and engage in battles, using the AI.AI_Cargo_APC module.
AI Helicopters to transport cargo, using the AI.AI_Cargo_Helicopter module.
AI Planes to transport cargo, using the AI.AI_Cargo_Airplane module.
AI Ships is planned.

The above cargo classes are also used by the TASK_CARGO_ classes to allow human players to transport cargo as part of a tasking:

Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT to transport cargo by human players.
Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR to transport downed pilots by human players.

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 CARGO_GROUP

CARGO_GROUP , extends Cargo.Cargo#CARGO_REPORTABLE

Fields and Methods inherited from CARGO_GROUP	Description
CARGO_GROUP.CargoCarrier
CARGO_GROUP.CargoGroup
CARGO_GROUP.CargoName
CARGO_GROUP.CargoObject
CARGO_GROUP.CargoSet	The collection of derived CARGO objects.
CARGO_GROUP.CargoTemplate
CARGO_GROUP.CargoUnitTemplate
CARGO_GROUP:Flare(FlareColor)	Signal a flare at the position of the CargoGroup.
CARGO_GROUP:GetCoordinate()	Get the current Coordinate of the CargoGroup.
CARGO_GROUP:GetCount()	Get the amount of cargo units in the group.
CARGO_GROUP:GetFirstAlive()	Get the first alive Cargo Unit of the Cargo Group.
CARGO_GROUP:GetGroup(Cargo)	Get the amount of cargo units in the group.
CARGO_GROUP:GetTransportationMethod()	Get the transportation method of the Cargo.
CARGO_GROUP.GroupName	The name of the CargoGroup.
CARGO_GROUP.GroupTemplate
CARGO_GROUP.Grouped
CARGO_GROUP:IsAlive()	Check if the CargoGroup is alive.
CARGO_GROUP:IsInLoadRadius(Coordinate)	Check if Cargo Group is in the radius for the Cargo to be Boarded.
CARGO_GROUP:IsInReportRadius(Coordinate)	Check if Cargo Group is in the report radius.
CARGO_GROUP:IsInZone(Zone)	Check if the first element of the CargoGroup is the given Core.Zone.
CARGO_GROUP:IsNear(CargoCarrier, NearRadius)	Check if Cargo is near to the Carrier.
CARGO_GROUP.NearRadius
CARGO_GROUP:New(CargoGroup, Type, Name, LoadRadius, NearRadius)	CARGO_GROUP constructor.
CARGO_GROUP:OnEventCargoDead(EventData)
CARGO_GROUP:Regroup()	Regroup the cargo group into one group with multiple unit.
CARGO_GROUP:Respawn()	Respawn the CargoGroup.
CARGO_GROUP:RouteTo(Coordinate)	Route Cargo to Coordinate and randomize locations.
CARGO_GROUP:Smoke(SmokeColor, Radius)	Smoke the CargoGroup.
CARGO_GROUP:Ungroup()	Ungroup the cargo group into individual groups with one unit.
CARGO_GROUP:onafterBoard(Event, From, To, CargoCarrier, NearRadius, ...)	After Board Event.
CARGO_GROUP:onafterBoarding(Event, From, To, CargoCarrier, NearRadius, ...)	Leave Boarding State.
CARGO_GROUP:onafterLoad(Event, From, To, CargoCarrier, ...)	Enter Loaded State.
CARGO_GROUP:onafterUnBoard(Event, From, To, ToPointVec2, NearRadius, ...)	Enter UnBoarding State.
CARGO_GROUP:onafterUnBoarding(Event, From, To, ToPointVec2, NearRadius, ...)	Leave UnBoarding State.
CARGO_GROUP:onafterUnLoad(Event, From, To, ToPointVec2, ...)	Enter UnLoaded State.

Field(s)

CARGO_GROUP.CargoCarrier

self.CargoObject:Destroy()

CARGO_GROUP.CargoGroup

CARGO_GROUP.CargoName

CARGO_GROUP.CargoObject

Now we spawn the new group based on the template created.

Core.Set#SET_CARGO CARGO_GROUP.CargoSet

The collection of derived CARGO objects.

CARGO_GROUP.CargoTemplate

#table CARGO_GROUP.CargoUnitTemplate

#string CARGO_GROUP.GroupName

The name of the CargoGroup.

CARGO_GROUP.GroupTemplate

#boolean CARGO_GROUP.Grouped

CARGO_GROUP.NearRadius

Function(s)

CARGO_GROUP:Flare(FlareColor)

Signal a flare at the position of the CargoGroup.

Defined in:

CARGO_GROUP

Parameter:

Utilities.Utils#FLARECOLOR FlareColor

CARGO_GROUP:GetCoordinate()

Get the current Coordinate of the CargoGroup.

Defined in:

CARGO_GROUP

Return values:

Core.Point#COORDINATE:

The current Coordinate of the first Cargo of the CargoGroup.

#nil:

There is no valid Cargo in the CargoGroup.

CARGO_GROUP:GetCount()

Get the amount of cargo units in the group.

Defined in:

CARGO_GROUP

Return value:

#CARGO_GROUP:

CARGO_GROUP:GetFirstAlive()

Get the first alive Cargo Unit of the Cargo Group.

Defined in:

CARGO_GROUP

Return value:

#CARGO_GROUP:

CARGO_GROUP:GetGroup(Cargo)

Get the amount of cargo units in the group.

Defined in:

CARGO_GROUP

Parameter:

Cargo

Return value:

#CARGO_GROUP:

CARGO_GROUP:GetTransportationMethod()

Get the transportation method of the Cargo.

Defined in:

CARGO_GROUP

Return value:

#string:

The transportation method of the Cargo.

Defined in:

CARGO_GROUP

Return values:

#boolean:

true if the CargoGroup is alive.

#boolean:

false if the CargoGroup is dead.

CARGO_GROUP:IsInLoadRadius(Coordinate)

Check if Cargo Group is in the radius for the Cargo to be Boarded.

Defined in:

CARGO_GROUP

Parameter:

Core.Point#COORDINATE Coordinate

Return value:

#boolean:

true if the Cargo Group is within the load radius.

CARGO_GROUP:IsInReportRadius(Coordinate)

Check if Cargo Group is in the report radius.

Defined in:

CARGO_GROUP

Parameter:

Core.Point#Coordinate Coordinate

Return value:

#boolean:

true if the Cargo Group is within the report radius.

CARGO_GROUP:IsInZone(Zone)

Check if the first element of the CargoGroup is the given Core.Zone.

Defined in:

CARGO_GROUP

Parameter:

Core.Zone#ZONE_BASE Zone

Return values:

#boolean:

true if the first element of the CargoGroup is in the Zone

#boolean:

false if there is no element of the CargoGroup in the Zone.

CARGO_GROUP:IsNear(CargoCarrier, NearRadius)

Check if Cargo is near to the Carrier.

The Cargo is near to the Carrier if the first unit of the Cargo Group is within NearRadius.

Defined in:

CARGO_GROUP

Parameters:

Wrapper.Group#GROUP CargoCarrier

#number NearRadius

Return value:

#boolean:

The Cargo is near to the Carrier or #nil if the Cargo is not near to the Carrier.

CARGO_GROUP:New(CargoGroup, Type, Name, LoadRadius, NearRadius)

CARGO_GROUP constructor.

This make a new CARGO_GROUP from a Wrapper.Group object. It will "ungroup" the group object within the sim, and will create a Core.Set of individual Unit objects.

Defined in:

CARGO_GROUP

Parameters:

Wrapper.Group#GROUP CargoGroup

Group to be transported as cargo.

#string Type

Cargo type, e.g. "Infantry". This is the type used in SET_CARGO:New():FilterTypes("Infantry") to define the valid cargo groups of the set.

#string Name

A user defined name of the cargo group. This name CAN be the same as the group object but can also have a different name. This name MUST be unique!

#number LoadRadius

(optional) Distance in meters until which a cargo is loaded into the carrier. Cargo outside this radius has to be routed by other means to within the radius to be loaded.

#number NearRadius

(optional) Once the units are within this radius of the carrier, they are actually loaded, i.e. disappear from the scene.

Return value:

#CARGO_GROUP:

Cargo group object.

CARGO_GROUP:OnEventCargoDead(EventData)

Defined in:

CARGO_GROUP

Parameter:

Core.Event#EVENTDATA EventData

CARGO_GROUP:Regroup()

Regroup the cargo group into one group with multiple unit.

This is required because by default a group will move in formation and this is really an issue for group control. Therefore this method is made to be able to regroup a group. This works for ground only groups.

Defined in:

CARGO_GROUP

CARGO_GROUP:Respawn()

Respawn the CargoGroup.

Defined in:

CARGO_GROUP

CARGO_GROUP:RouteTo(Coordinate)

Route Cargo to Coordinate and randomize locations.

Defined in:

CARGO_GROUP

Parameter:

Core.Point#COORDINATE Coordinate

CARGO_GROUP:Smoke(SmokeColor, Radius)

Smoke the CargoGroup.

Defined in:

CARGO_GROUP

Parameters:

Utilities.Utils#SMOKECOLOR SmokeColor

The color of the smoke.

#number Radius

The radius of randomization around the center of the first element of the CargoGroup.

CARGO_GROUP:Ungroup()

Ungroup the cargo group into individual groups with one unit.

This is required because by default a group will move in formation and this is really an issue for group control. Therefore this method is made to be able to ungroup a group. This works for ground only groups.