Module AI.AI_Cargo_Dispatcher_Helicopter
AI - Models the intelligent transportation of infantry and other cargo using Helicopters.
Features:
- The helicopters will fly towards the pickup locations to pickup the cargo.
- The helicopters will fly towards the deploy zones to deploy the cargo.
- Precision deployment as well as randomized deployment within the deploy zones are possible.
- Helicopters will orbit the deploy zones when there is no space for landing until the deploy zone is free.
Test Missions:
Test missions can be located on the main GITHUB site.
[FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]
(https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
Author: FlightControl
Global(s)
Global AI_CARGO_DISPATCHER_HELICOPTER |
A dynamic cargo handling capability for AI helicopter groups. |
A dynamic cargo handling capability for AI helicopter groups.
Helicopters can be mobilized to intelligently transport infantry and other cargo within the simulation.
The AI_CARGO_DISPATCHER_HELICOPTER module is derived from the AI_CARGO_DISPATCHER module.
Note! In order to fully understand the mechanisms of the AI_CARGO_DISPATCHER_HELICOPTER class, it is recommended that you first consult and READ the documentation of the AI.AI_Cargo_Dispatcher module!!!**
Especially to learn how to Tailor the different cargo handling events, this will be very useful!
On top, the AI_CARGO_DISPATCHER_HELICOPTER class uses the Cargo.Cargo capabilities within the MOOSE framework. Also ensure that you fully understand how to declare and setup Cargo objects within the MOOSE framework before using this class. CARGO derived objects must be declared within the mission to make the AI_CARGO_DISPATCHER_HELICOPTER object recognize the cargo.
1. AI_CARGO_DISPATCHER_HELICOPTER constructor.
- #AI_CARGO_DISPATCHER(): Creates a new AI_CARGO_DISPATCHER_HELICOPTER object.
2. AI_CARGO_DISPATCHER_HELICOPTER is a Finite State Machine.
This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed. The first column is the From state, the second column the Event, and the third column the To state.
So, each of the rows have the following structure.
- From => Event => To
Important to know is that an event can only be executed if the current state is the From state. This, when an Event that is being triggered has a From state that is equal to the Current state of the state machine, the event will be executed, and the resulting state will be the To state.
These are the different possible state transitions of this state machine implementation:
Idle => Start => Monitoring
Monitoring => Monitor => Monitoring
Monitoring => Stop => Idle
Monitoring => Pickup => Monitoring
Monitoring => Load => Monitoring
Monitoring => Loading => Monitoring
Monitoring => Loaded => Monitoring
Monitoring => PickedUp => Monitoring
Monitoring => Deploy => Monitoring
Monitoring => Unload => Monitoring
Monitoring => Unloaded => Monitoring
Monitoring => Deployed => Monitoring
Monitoring => Home => Monitoring
2.1) AI_CARGO_DISPATCHER States.
- Monitoring: The process is dispatching.
- Idle: The process is idle.
2.2) AI_CARGO_DISPATCHER Events.
Start: Start the transport process.
Stop: Stop the transport process.
Monitor: Monitor and take action.
Pickup: Pickup cargo.
Load: Load the cargo.
Loading: The dispatcher is coordinating the loading of a cargo.
Loaded: Flag that the cargo is loaded.
PickedUp: The dispatcher has loaded all requested cargo into the CarrierGroup.
Deploy: Deploy cargo to a location.
Unload: Unload the cargo.
Unloaded: Flag that the cargo is unloaded.
Deployed: All cargo is unloaded from the carriers in the group.
Home: A Carrier is going home.
2.3) Enhance your mission scripts with Tailored Event Handling!
Within your mission, you can capture these events when triggered, and tailor the events with your own code! Check out the AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER class at chapter 3 for details on the different event handlers that are available and how to use them.
There are a lot of templates available that allows you to quickly setup an event handler for a specific event type!
3. Set the pickup parameters.
Several parameters can be set to pickup cargo:
- AI_CARGO_DISPATCHER_HELICOPTER.SetPickupRadius(): Sets or randomizes the pickup location for the helicopter around the cargo coordinate in a radius defined an outer and optional inner radius.
- AI_CARGO_DISPATCHER_HELICOPTER.SetPickupSpeed(): Set the speed or randomizes the speed in km/h to pickup the cargo.
- AI_CARGO_DISPATCHER_HELICOPTER.SetPickupHeight(): Set the height or randomizes the height in meters to pickup the cargo.
4. Set the deploy parameters.
Several parameters can be set to deploy cargo:
- AI_CARGO_DISPATCHER_HELICOPTER.SetDeployRadius(): Sets or randomizes the deploy location for the helicopter around the cargo coordinate in a radius defined an outer and an optional inner radius.
- AI_CARGO_DISPATCHER_HELICOPTER.SetDeploySpeed(): Set the speed or randomizes the speed in km/h to deploy the cargo.
- AI_CARGO_DISPATCHER_HELICOPTER.SetDeployHeight(): Set the height or randomizes the height in meters to deploy the cargo.
5. Set the home zone when there isn't any more cargo to pickup.
A home zone can be specified to where the Helicopters will move when there isn't any cargo left for pickup. Use AI_CARGO_DISPATCHER_HELICOPTER.SetHomeZone() to specify the home zone.
If no home zone is specified, the helicopters will wait near the deploy zone for a new pickup command.
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)
| Fields and Methods inherited from AI_CARGO_DISPATCHER_HELICOPTER | Description |
|---|---|
AI_CARGO_DISPATCHER_HELICOPTER:AICargo(Helicopter, CargoSet) |
|
AI_CARGO_DISPATCHER_HELICOPTER:New(HelicopterSet, CargoSet, PickupZoneSet, DeployZoneSet) |
Creates a new AI_CARGO_DISPATCHER_HELICOPTER object. |
| Fields and Methods inherited from AI_CARGO_DISPATCHER | Description |
|---|---|
|
List of AI_Cargo |
|
AI_CARGO_DISPATCHER_HELICOPTER:New(CarrierSet, CargoSet, PickupZoneSet, DeployZoneSet) |
Creates a new AI_CARGO_DISPATCHER object. |
|
Deploy event handler OnAfter for AI_CARGO_DISPATCHER. |
|
AI_CARGO_DISPATCHER_HELICOPTER:OnAfterDeployed(From, Event, To, CarrierGroup, DeployZone) |
Deployed event handler OnAfter for AI_CARGO_DISPATCHER. |
|
Home event handler OnAfter for AI_CARGO_DISPATCHER. |
|
AI_CARGO_DISPATCHER_HELICOPTER:OnAfterLoad(From, Event, To, CarrierGroup, PickupZone) |
Load event handler OnAfter for AI_CARGO_DISPATCHER. |
|
Loaded event handler OnAfter for AI_CARGO_DISPATCHER. |
|
|
Loading event handler OnAfter for AI_CARGO_DISPATCHER. |
|
AI_CARGO_DISPATCHER_HELICOPTER:OnAfterPickedUp(From, Event, To, CarrierGroup, PickupZone) |
PickedUp event handler OnAfter for AI_CARGO_DISPATCHER. |
|
Pickup event handler OnAfter for AI_CARGO_DISPATCHER. |
|
AI_CARGO_DISPATCHER_HELICOPTER:OnAfterUnload(From, Event, To, CarrierGroup, DeployZone) |
Unload event handler OnAfter for AI_CARGO_DISPATCHER. |
|
Unloaded event handler OnAfter for AI_CARGO_DISPATCHER. |
|
|
UnLoading event handler OnAfter for AI_CARGO_DISPATCHER. |
|
AI_CARGO_DISPATCHER_HELICOPTER:SetDeployHeight(MaxHeight, MinHeight) |
Set the height or randomizes the height in meters to fly and deploy the cargo. |
AI_CARGO_DISPATCHER_HELICOPTER:SetDeployRadius(OuterRadius, InnerRadius) |
Sets or randomizes the deploy location for the carrier around the cargo coordinate in a radius defined an outer and an optional inner radius. |
AI_CARGO_DISPATCHER_HELICOPTER:SetDeploySpeed(MaxSpeed, MinSpeed) |
Sets or randomizes the speed in km/h to deploy the cargo. |
|
Set the home zone. |
|
AI_CARGO_DISPATCHER_HELICOPTER:SetMonitorTimeInterval(MonitorTimeInterval) |
Set the monitor time interval. |
AI_CARGO_DISPATCHER_HELICOPTER:SetPickupHeight(MaxHeight, MinHeight) |
Set the height or randomizes the height in meters to fly and pickup the cargo. |
AI_CARGO_DISPATCHER_HELICOPTER:SetPickupRadius(OuterRadius, InnerRadius) |
Sets or randomizes the pickup location for the carrier around the cargo coordinate in a radius defined an outer and optional inner radius. |
AI_CARGO_DISPATCHER_HELICOPTER:SetPickupSpeed(MaxSpeed, MinSpeed) |
Set the speed or randomizes the speed in km/h to pickup the cargo. |
|
Start Trigger for AI_CARGO_DISPATCHER |
|
|
Stop Trigger for AI_CARGO_DISPATCHER |
|
|
Start Asynchronous Trigger for AI_CARGO_DISPATCHER |
|
|
Stop Asynchronous Trigger for AI_CARGO_DISPATCHER |
|
|
The Start trigger event, which actually takes action at the specified time interval. |
|
AI_CARGO_DISPATCHER_HELICOPTER:onafterStart(From, Event, To) |
|
AI_CARGO_DISPATCHER_HELICOPTER:onafterTransport(From, Event, To, Carrier, Cargo) |
Make a Carrier run for a cargo deploy action after the cargo has been loaded, by default. |
Field(s)
Function(s)
Defined in:
AI_CARGO_DISPATCHER_HELICOPTER
Parameters:
Helicopter
CargoSet
Creates a new AI_CARGO_DISPATCHER_HELICOPTER object.
Defined in:
AI_CARGO_DISPATCHER_HELICOPTER
Parameters:
Core.Set#SET_GROUP HelicopterSet
The set of Wrapper.Group#GROUP objects of helicopters that will transport the cargo.
Core.Set#SET_CARGO CargoSet
The set of Cargo.Cargo#CARGO objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.
Core.Set#SET_ZONE PickupZoneSet
(optional) The set of pickup zones, which are used to where the cargo can be picked up by the APCs. If nil, then cargo can be picked up everywhere.
Core.Set#SET_ZONE DeployZoneSet
The set of deploy zones, which are used to where the cargo will be deployed by the Helicopters.
Return value:
Usage:
-- An AI dispatcher object for a helicopter squadron, moving infantry from pickup zones to deploy zones.
local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
local SetHelicopter = SET_GROUP:New():FilterPrefixes( "Helicopter" ):FilterStart()
local SetPickupZones = SET_ZONE:New():FilterPrefixes( "Pickup" ):FilterStart()
local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
AICargoDispatcherHelicopter:Start()
Field(s)
Function(s)
Creates a new AI_CARGO_DISPATCHER object.
Defined in:
Parameters:
Core.Set#SET_GROUP CarrierSet
The set of Wrapper.Group#GROUP objects of carriers that will transport the cargo.
Core.Set#SET_CARGO CargoSet
The set of Cargo.Cargo#CARGO objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.
Core.Set#SET_ZONE PickupZoneSet
(optional) The set of pickup zones, which are used to where the cargo can be picked up by the carriers. If nil, then cargo can be picked up everywhere.
Core.Set#SET_ZONE DeployZoneSet
The set of deploy zones, which are used to where the cargo will be deployed by the carriers.
Return value:
Usages:
-- An AI dispatcher object for a helicopter squadron, moving infantry from pickup zones to deploy zones. local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart() local SetHelicopter = SET_GROUP:New():FilterPrefixes( "Helicopter" ):FilterStart() local SetPickupZones = SET_ZONE:New():FilterPrefixes( "Pickup" ):FilterStart() local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart() AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) AICargoDispatcherHelicopter:Start()-- An AI dispatcher object for a vehicle squadron, moving infantry from pickup zones to deploy zones. local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart() local SetAPC = SET_GROUP:New():FilterPrefixes( "APC" ):FilterStart() local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart() AICargoDispatcherAPC = AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargoInfantry, nil, SetDeployZones ) AICargoDispatcherAPC:Start()-- An AI dispatcher object for an airplane squadron, moving infantry and vehicles from pickup airbases to deploy airbases. local CargoInfantrySet = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart() local AirplanesSet = SET_GROUP:New():FilterPrefixes( "Airplane" ):FilterStart() local PickupZoneSet = SET_ZONE:New() local DeployZoneSet = SET_ZONE:New() PickupZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Gudauta ) ) DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Sochi_Adler ) ) DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Maykop_Khanskaya ) ) DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Mineralnye_Vody ) ) DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Vaziani ) ) AICargoDispatcherAirplanes = AI_CARGO_DISPATCHER_AIRPLANE:New( AirplanesSet, CargoInfantrySet, PickupZoneSet, DeployZoneSet ) AICargoDispatcherAirplanes:Start()
Deploy event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierGroup is routed to a deploy coordinate, to Unload all cargo objects in each CarrierUnit. You can use this event handler to post messages to players, or provide status updates etc.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Core.Point#COORDINATE Coordinate
The deploy coordinate.
#number Speed
The velocity in meters per second on which the CarrierGroup is routed towards the deploy Coordinate.
#number Height
Height in meters to move to the deploy coordinate.
Core.Zone#ZONE DeployZone
The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
Deployed event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a carrier has deployed all cargo objects from the CarrierGroup. You can use this event handler to post messages to players, or provide status updates etc.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Core.Zone#ZONE DeployZone
The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
Home event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierGroup is returning to the HomeZone, after it has deployed all cargo objects from the CarrierGroup. You can use this event handler to post messages to players, or provide status updates etc. If there is no HomeZone is specified, the CarrierGroup will stay at the current location after having deployed all cargo.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Core.Point#COORDINATE Coordinate
The home coordinate the Carrier will arrive and stop it's activities.
#number Speed
The velocity in meters per second on which the CarrierGroup is routed towards the home Coordinate.
#number Height
Height in meters to move to the home coordinate.
Core.Zone#ZONE HomeZone
The zone wherein the carrier will return when all cargo has been transported. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
Load event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierGroup has initiated the loading or boarding of cargo within reporting or near range. You can use this event handler to post messages to players, or provide status updates etc.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Core.Zone#ZONE_AIRBASE PickupZone
(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.
Loaded event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup has loaded a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that if more cargo objects were loading or boarding into the CarrierUnit, then this event can be triggered multiple times for each different Cargo/CarrierUnit. A CarrierUnit can be part of the larger CarrierGroup.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Cargo.Cargo#CARGO Cargo
The cargo object.
Wrapper.Unit#UNIT CarrierUnit
The carrier unit that is executing the cargo loading operation.
Core.Zone#ZONE_AIRBASE PickupZone
(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.
Loading event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup is in the process of loading or boarding of a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that this event is triggered repeatedly until all cargo (units) have been boarded into the carrier.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Cargo.Cargo#CARGO Cargo
The cargo object.
Wrapper.Unit#UNIT CarrierUnit
The carrier unit that is executing the cargo loading operation.
Core.Zone#ZONE_AIRBASE PickupZone
(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.
PickedUp event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a carrier has picked up all cargo objects into the CarrierGroup. You can use this event handler to post messages to players, or provide status updates etc.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Core.Zone#ZONE_AIRBASE PickupZone
(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.
Pickup event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierGroup is routed towards a new pickup Coordinate and a specified Speed. You can use this event handler to post messages to players, or provide status updates etc.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Core.Point#COORDINATE Coordinate
The coordinate of the pickup location.
#number Speed
The velocity in meters per second on which the CarrierGroup is routed towards the pickup Coordinate.
#number Height
Height in meters to move to the pickup coordinate.
Core.Zone#ZONE_AIRBASE PickupZone
(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.
Unload event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierGroup has initiated the unloading or unboarding of cargo. You can use this event handler to post messages to players, or provide status updates etc.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Core.Zone#ZONE DeployZone
The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
Unloaded event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup has unloaded a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that if more cargo objects were unloading or unboarding from the CarrierUnit, then this event can be triggered multiple times for each different Cargo/CarrierUnit. A CarrierUnit can be part of the larger CarrierGroup.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Cargo.Cargo#CARGO Cargo
The cargo object.
Wrapper.Unit#UNIT CarrierUnit
The carrier unit that is executing the cargo unloading operation.
Core.Zone#ZONE DeployZone
The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
UnLoading event handler OnAfter for AI_CARGO_DISPATCHER.
Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup is in the process of unloading or unboarding of a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that this event is triggered repeatedly until all cargo (units) have been unboarded from the CarrierUnit.
Defined in:
Parameters:
#string From
A string that contains the "from state name" when the event was triggered.
#string Event
A string that contains the "event name" when the event was triggered.
#string To
A string that contains the "to state name" when the event was triggered.
Wrapper.Group#GROUP CarrierGroup
The group object that contains the CarrierUnits.
Cargo.Cargo#CARGO Cargo
The cargo object.
Wrapper.Unit#UNIT CarrierUnit
The carrier unit that is executing the cargo unloading operation.
Core.Zone#ZONE DeployZone
The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
Set the height or randomizes the height in meters to fly and deploy the cargo.
The default height is 200 meters.
Defined in:
Parameters:
#number MaxHeight
(optional) The maximum height to fly to the cargo deploy location.
#number MinHeight
(optional) The minimum height to fly to the cargo deploy location.
Return value:
Usage:
-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
-- Set the minimum deploy fly height to be 50 meters and the maximum height to be 200 meters.
AICargoDispatcherHelicopter:SetDeployHeight( 200, 50 )
Sets or randomizes the deploy location for the carrier around the cargo coordinate in a radius defined an outer and an optional inner radius.
This radius is influencing the location where the carrier will land to deploy the cargo. There is an aspect that is very important to remember and take into account:
- Take care of the potential cargo position and possible reasons to crash the carrier. This is especially important for locations which are crowded with other objects, like in the middle of villages or cities. So, for the best operation of cargo operations, always ensure that the cargo is located at open spaces.
The default radius is 0, so the center. In case of a polygon zone, a random location will be selected as the center in the zone.
Defined in:
Parameters:
#number OuterRadius
The outer radius in meters around the cargo coordinate.
#number InnerRadius
(optional) The inner radius in meters around the cargo coordinate.
Return value:
Usage:
-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
-- Set the carrier to land within a band around the cargo coordinate between 500 and 300 meters!
AICargoDispatcherHelicopter:SetDeployRadius( 500, 300 )
Sets or randomizes the speed in km/h to deploy the cargo.
Defined in:
Parameters:
#number MaxSpeed
The maximum speed to move to the cargo deploy location.
#number MinSpeed
(optional) The minimum speed to move to the cargo deploy location.
Return value:
Usage:
-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
-- Set the minimum deploy speed to be 100 km/h and the maximum speed to be 200 km/h.
AICargoDispatcherHelicopter:SetDeploySpeed( 200, 100 )
Set the home zone.
When there is nothing anymore to pickup, the carriers will go to a random coordinate in this zone. They will await here new orders.
Defined in:
Parameter:
Core.Zone#ZONE_BASE HomeZone
The home zone where the carriers will return when there is no more cargo to pickup.
Return value:
Usage:
-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
-- Set the home coordinate
local HomeZone = ZONE:New( "Home" )
AICargoDispatcherHelicopter:SetHomeZone( HomeZone )
Set the monitor time interval.
Defined in:
Parameter:
#number MonitorTimeInterval
The interval in seconds when the cargo dispatcher will search for new cargo to be picked up.
Return value:
Set the height or randomizes the height in meters to fly and pickup the cargo.
The default height is 200 meters.
Defined in:
Parameters:
#number MaxHeight
(optional) The maximum height to fly to the cargo pickup location.
#number MinHeight
(optional) The minimum height to fly to the cargo pickup location.
Return value:
Usage:
-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
-- Set the minimum pickup fly height to be 50 meters and the maximum height to be 200 meters.
AICargoDispatcherHelicopter:SetPickupHeight( 200, 50 )
Sets or randomizes the pickup location for the carrier around the cargo coordinate in a radius defined an outer and optional inner radius.
This radius is influencing the location where the carrier will land to pickup the cargo. There are two aspects that are very important to remember and take into account:
- Ensure that the outer and inner radius are within reporting radius set by the cargo. For example, if the cargo has a reporting radius of 400 meters, and the outer and inner radius is set to 500 and 450 respectively, then no cargo will be loaded!!!
- Also take care of the potential cargo position and possible reasons to crash the carrier. This is especially important for locations which are crowded with other objects, like in the middle of villages or cities. So, for the best operation of cargo operations, always ensure that the cargo is located at open spaces.
The default radius is 0, so the center. In case of a polygon zone, a random location will be selected as the center in the zone.
Defined in:
Parameters:
#number OuterRadius
The outer radius in meters around the cargo coordinate.
#number InnerRadius
(optional) The inner radius in meters around the cargo coordinate.
Return value:
Usage:
-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
-- Set the carrier to land within a band around the cargo coordinate between 500 and 300 meters!
AICargoDispatcherHelicopter:SetPickupRadius( 500, 300 )
Set the speed or randomizes the speed in km/h to pickup the cargo.
Defined in:
Parameters:
#number MaxSpeed
(optional) The maximum speed to move to the cargo pickup location.
#number MinSpeed
The minimum speed to move to the cargo pickup location.
Return value:
Usage:
-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones )
-- Set the minimum pickup speed to be 100 km/h and the maximum speed to be 200 km/h.
AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
Start Trigger for AI_CARGO_DISPATCHER
Defined in:
Stop Trigger for AI_CARGO_DISPATCHER
Defined in:
Start Asynchronous Trigger for AI_CARGO_DISPATCHER
Stop Asynchronous Trigger for AI_CARGO_DISPATCHER
The Start trigger event, which actually takes action at the specified time interval.
Defined in:
Make a Carrier run for a cargo deploy action after the cargo has been loaded, by default.
Defined in:
Parameters:
From
Event
To
Wrapper.Group#GROUP Carrier
Cargo.Cargo#CARGO Cargo