Module AI.AI_Cargo_Dispatcher_APC

Usage:


     -- 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()

AI_CARGO_DISPATCHER_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_DISPATCHER_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 (default), no defense will happen of the carrier. When the combat radius is not provided, no defense will happen!

Return value:

Usage:


-- Disembark the infantry when the carrier is under attack.
AICargoDispatcher:SetCombatRadius( 500 )

-- Keep the cargo in the carrier when the carrier is under attack.
AICargoDispatcher:SetCombatRadius( 0 )

AI_CARGO_DISPATCHER_APC:SetDeployOffRoad(Offroad, Formation)

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

Defined in:

AI_CARGO_DISPATCHER_APC

Parameters:

#boolean Offroad

If true, carrier will not use roads.

#number Formation

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

Return value:

self

AI_CARGO_DISPATCHER_APC:SetOffRoad(Offroad, Formation)

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

Defined in:

AI_CARGO_DISPATCHER_APC

Parameters:

#boolean Offroad

If true, carrier will not use roads.

#number Formation

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

Return value:

self

AI_CARGO_DISPATCHER_APC:SetPickupOffRoad(Offroad, Formation)

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

Defined in:

AI_CARGO_DISPATCHER_APC

Parameters:

#boolean Offroad

If true, carrier will not use roads.

#number Formation

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

Return value:

self

Field(s)

AI_CARGO_DISPATCHER_APC.deployOffroad

AI_CARGO_DISPATCHER_APC.pickupOffroad

Function(s)

AI_CARGO_DISPATCHER_APC:New(CarrierSet, CargoSet, PickupZoneSet, DeployZoneSet)

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()

AI_CARGO_DISPATCHER_APC:OnAfterDeploy(From, Event, To, CarrierGroup, Coordinate, Speed, Height, DeployZone)

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.

AI_CARGO_DISPATCHER_APC:OnAfterDeployed(From, Event, To, CarrierGroup, DeployZone)

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.

AI_CARGO_DISPATCHER_APC:OnAfterHome(From, Event, To, CarrierGroup, Coordinate, Speed, Height, HomeZone)

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.

AI_CARGO_DISPATCHER_APC:OnAfterLoad(From, Event, To, CarrierGroup, PickupZone)

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.

AI_CARGO_DISPATCHER_APC:OnAfterLoaded(From, Event, To, CarrierGroup, Cargo, CarrierUnit, PickupZone)

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

AI_CARGO_DISPATCHER_APC:OnAfterLoading(From, Event, To, CarrierGroup, Cargo, CarrierUnit, PickupZone)

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

AI_CARGO_DISPATCHER_APC:OnAfterPickedUp(From, Event, To, CarrierGroup, PickupZone)

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

AI_CARGO_DISPATCHER_APC:OnAfterPickup(From, Event, To, CarrierGroup, Coordinate, Speed, Height, PickupZone)

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

AI_CARGO_DISPATCHER_APC:OnAfterUnload(From, Event, To, CarrierGroup, DeployZone)

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.

AI_CARGO_DISPATCHER_APC:OnAfterUnloaded(From, Event, To, CarrierGroup, Cargo, CarrierUnit, DeployZone)

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.

AI_CARGO_DISPATCHER_APC:OnAfterUnloading(From, Event, To, CarrierGroup, Cargo, CarrierUnit, DeployZone)

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.

AI_CARGO_DISPATCHER_APC:SetDeployHeight(MaxHeight, MinHeight)

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 )

AI_CARGO_DISPATCHER_APC: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.

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 )

AI_CARGO_DISPATCHER_APC:SetDeploySpeed(MaxSpeed, MinSpeed)

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 )

AI_CARGO_DISPATCHER_APC:SetHomeZone(HomeZone)

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 )

AI_CARGO_DISPATCHER_APC:SetMonitorTimeInterval(MonitorTimeInterval)

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:

AI_CARGO_DISPATCHER_APC:SetPickupHeight(MaxHeight, MinHeight)

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 )

AI_CARGO_DISPATCHER_APC: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.

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 )

AI_CARGO_DISPATCHER_APC:SetPickupSpeed(MaxSpeed, MinSpeed)

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: