Module AI.AI_Cargo
AI - Models the intelligent transportation of infantry and other cargo.
Author: FlightControl
Global(s)
Global AI_CARGO |
Base class for the dynamic cargo handling capability for AI groups. |
Base class for the dynamic cargo handling capability for AI groups.
Carriers can be mobilized to intelligently transport infantry and other cargo within the simulation. The AI_CARGO module uses the Cargo.Cargo capabilities within the MOOSE framework. CARGO derived objects must be declared within the mission to make the AI_CARGO object recognize the cargo. Please consult the Cargo.Cargo module for more information.
The derived classes from this module are:
- AI.AI_Cargo_APC - Cargo transportation using APCs and other vehicles between zones.
- AI.AI_Cargo_Helicopter - Cargo transportation using helicopters between zones.
- AI.AI_Cargo_Airplane - Cargo transportation using airplanes to and from airbases.
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 FSM_CONTROLLABLE | Description |
|---|---|
|
Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs. |
|
|
Creates a new FSM_CONTROLLABLE object. |
|
|
OnAfter Transition Handler for Event Stop. |
|
|
OnBefore Transition Handler for Event Stop. |
|
|
OnEnter Transition Handler for State Stopped. |
|
|
OnLeave Transition Handler for State Stopped. |
|
|
Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs. |
|
|
Synchronous Event Trigger for Event Stop. |
|
|
Asynchronous Event Trigger for Event Stop. |
|
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End state. |
|
|
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task. |
|
|
Adds a score for the FSM to be achieved. |
|
AI_CARGO:AddScoreProcess(From, Event, State, ScoreText, Score) |
Adds a score for the FSM_PROCESS to be achieved. |
|
Add a new transition rule to the FSM. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Check if FSM is in state. |
|
Field(s)
Function(s)
Deploy Trigger for AI_CARGO
Defined in:
AI_CARGO
Parameters:
Core.Point#COORDINATE Coordinate
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
Defined in:
AI_CARGO
Defined in:
AI_CARGO
Creates a new AI_CARGO object.
Defined in:
AI_CARGO
Parameters:
Wrapper.Group#GROUP Carrier
Cargo carrier group.
Core.Set#SET_CARGO CargoSet
Set of cargo(s) to transport.
Return value:
self
Deploy Handler OnAfter for AI_CARGO
Defined in:
AI_CARGO
Parameters:
#string From
#string Event
#string To
Core.Point#COORDINATE Coordinate
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
On after Deployed event.
Defined in:
AI_CARGO
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.
#boolean Defend
Defend for APCs.
Loaded Handler OnAfter for AI_CARGO
Pickup Handler OnAfter for AI_CARGO
Defined in:
AI_CARGO
Parameters:
#string From
#string Event
#string To
Core.Point#COORDINATE Coordinate
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
Unloaded Handler OnAfter for AI_CARGO
Deploy Handler OnBefore for AI_CARGO
Defined in:
AI_CARGO
Parameters:
#string From
#string Event
#string To
Core.Point#COORDINATE Coordinate
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
Return value:
#boolean:
Pickup Handler OnBefore for AI_CARGO
Defined in:
AI_CARGO
Parameters:
#string From
#string Event
#string To
Core.Point#COORDINATE Coordinate
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
Return value:
#boolean:
Pickup Trigger for AI_CARGO
Defined in:
AI_CARGO
Parameters:
Core.Point#COORDINATE Coordinate
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
Deploy Asynchronous Trigger for AI_CARGO
Defined in:
AI_CARGO
Parameters:
#number Delay
Core.Point#COORDINATE Coordinate
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
Pickup Asynchronous Trigger for AI_CARGO
Defined in:
AI_CARGO
Parameters:
#number Delay
Core.Point#COORDINATE Coordinate
Pickup place. If not given, loading starts at the current location.
#number Speed
Speed in km/h. Default is 50% of max possible speed the group can do.
On after Board event.
Defined in:
AI_CARGO
Parameters:
Wrapper.Group#GROUP Carrier
#string From
From state.
#string Event
Event.
#string To
To state.
Cargo.Cargo#CARGO Cargo
Cargo object.
Wrapper.Unit#UNIT CarrierUnit
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.
On after Deploy event.
Defined in:
AI_CARGO
Parameters:
From
Event
To
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.
Core.Zone#ZONE DeployZone
The zone where the cargo will be deployed.
On after Deployed event.
Defined in:
AI_CARGO
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.
#boolean Defend
Defend for APCs.
On after Loaded event.
Defined in:
AI_CARGO
Parameters:
Wrapper.Group#GROUP Carrier
#string From
From state.
#string Event
Event.
#string To
To state.
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.
Cargo
Return value:
#boolean:
Cargo loaded.
On after PickedUp event.
Defined in:
AI_CARGO
Parameters:
Wrapper.Group#GROUP Carrier
#string From
From state.
#string Event
Event.
#string To
To state.
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.
On after Pickup event.
Defined in:
AI_CARGO
Parameters:
From
Event
To
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 home coordinate.
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.
On after Unboard event.
Defined in:
AI_CARGO
Parameters:
Wrapper.Group#GROUP Carrier
#string From
From state.
#string Event
Event.
#string To
To state.
#string Cargo
Cargo#CARGO Cargo Cargo object.
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
On after Unload event.
Defined in:
AI_CARGO
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.
Defend
AI_CARGO:onafterUnloaded(Carrier, From, Event, To, Cargo, Deployed, DeployZone, CarrierUnit, Defend)
On after Unloaded event.
Defined in:
AI_CARGO
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
On before Load event.
Defined in:
AI_CARGO
Parameters:
Wrapper.Group#GROUP Carrier
#string From
From state.
#string Event
Event.
#string To
To state.
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.
On before Reload event.
Defined in:
AI_CARGO
Parameters:
Wrapper.Group#GROUP Carrier
#string From
From state.
#string Event
Event.
#string To
To state.
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.
Field(s)
Function(s)
Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.
Creates a new FSM_CONTROLLABLE object.
Defined in:
Parameters:
#table FSMT
Finite State Machine Table
Wrapper.Controllable#CONTROLLABLE Controllable
(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.
Return value:
OnAfter Transition Handler for Event Stop.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnBefore Transition Handler for Event Stop.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnEnter Transition Handler for State Stopped.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnLeave Transition Handler for State Stopped.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.
Asynchronous Event Trigger for Event Stop.
Field(s)
Function(s)
Adds an End state.
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
Core.Fsm#FSM_PROCESS Process
An sub-process FSM.
#table ReturnEvents
A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.
Return value:
The SubFSM.
Adds a score for the FSM to be achieved.
Defined in:
Parameters:
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Adds a score for the FSM_PROCESS to be achieved.
Defined in:
Parameters:
#string From
is the From State of the main process.
#string Event
is the Event of the main process.
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Add a new transition rule to the FSM.
A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
#string To
The To state.
Get current state.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
Check if FSM is in state.
Defined in:
Parameter:
#string State
State name.
Return value:
#boolean:
If true, FSM is in this state.
Load call backs.
Sets the start state of the FSM.
Add to map.
Call handler.
Defined in:
Parameters:
#string step
Step "onafter", "onbefore", "onenter", "onleave".
#string trigger
Trigger.
#table params
Parameters.
#string EventName
Event name.
Return value:
Value.
Create transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Delayed transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Event map.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
Check if can do an event.
Defined in:
Parameter:
#string e
Event name.
Return values:
#boolean:
If true, FSM can do the event.
#string:
To state.
Check if cannot do an event.
Defined in:
Parameter:
#string e
Event name.
Return value:
#boolean:
If true, FSM cannot do the event.
Check if FSM is in state.
Defined in:
Parameters:
#string State
State name.
state
Return value:
#boolean:
If true, FSM is in this state.