+
+
+
Module AI_BAI
+
+
AI -- Provide Battleground Air Interdiction (bombing).
+
+
+
+
+
+
AI_BAI classes makes AI Controllables execute bombing tasks.
+
+
+
+
There are the following types of BAI classes defined:
+
+
+
+
+
+
Demo Missions
+
+
+
+
+
+
+
+
+
+
YouTube Channel
+
+
+
+
+
+
API CHANGE HISTORY
+
+
The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+
+
+ - Added parts are expressed in bold type face.
+ - Removed parts are expressed in italic type face.
+
+
+
Hereby the change log:
+
+
2017-01-15: Initial class and API.
+
+
+
+
AUTHORS and CONTRIBUTIONS
+
+
Contributions:
+
+
+
+
Authors:
+
+
+ - FlightControl: Concept, Design & Programming.
+
+
+
+
Global(s)
+
+
+
+
+ | AI_BAI_ZONE.AIControllable |
+
+ The Controllable patrolling.
+ |
+
+
+ | AI_BAI_ZONE:Abort() |
+
+ Synchronous Event Trigger for Event Abort.
+ |
+
+
+ | AI_BAI_ZONE:Accomplish() |
+
+ Synchronous Event Trigger for Event Accomplish.
+ |
+
+
+ | AI_BAI_ZONE.Accomplished |
+
+
+ |
+
+
+ | AI_BAI_ZONE:Destroy() |
+
+ Synchronous Event Trigger for Event Destroy.
+ |
+
+
+ | AI_BAI_ZONE:Engage(EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection) |
+
+ Synchronous Event Trigger for Event Engage.
+ |
+
+
+ | AI_BAI_ZONE.EngageAltitude |
+
+
+ |
+
+
+ | AI_BAI_ZONE.EngageAttackQty |
+
+
+ |
+
+
+ | AI_BAI_ZONE.EngageDirection |
+
+
+ |
+
+
+ | AI_BAI_ZONE.EngageSpeed |
+
+
+ |
+
+
+ | AI_BAI_ZONE.EngageWeaponExpend |
+
+
+ |
+
+
+ | AI_BAI_ZONE.EngageZone |
+
+
+ |
+
+
+ | AI_BAI_ZONE:Fired() |
+
+ Synchronous Event Trigger for Event Fired.
+ |
+
+
+ | AI_BAI_ZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageZone, PatrolAltType) |
+
+ Creates a new AIBAIZONE object
+ |
+
+
+ | AI_BAI_ZONE:OnAfterAbort(Controllable, From, Event, To) |
+
+ OnAfter Transition Handler for Event Abort.
+ |
+
+
+ | AI_BAI_ZONE:OnAfterAccomplish(Controllable, From, Event, To) |
+
+ OnAfter Transition Handler for Event Accomplish.
+ |
+
+
+ | AI_BAI_ZONE:OnAfterDestroy(Controllable, From, Event, To) |
+
+ OnAfter Transition Handler for Event Destroy.
+ |
+
+
+ | AI_BAI_ZONE:OnAfterEngage(Controllable, From, Event, To) |
+
+ OnAfter Transition Handler for Event Engage.
+ |
+
+
+ | AI_BAI_ZONE:OnAfterFired(Controllable, From, Event, To) |
+
+ OnAfter Transition Handler for Event Fired.
+ |
+
+
+ | AI_BAI_ZONE:OnBeforeAbort(Controllable, From, Event, To) |
+
+ OnBefore Transition Handler for Event Abort.
+ |
+
+
+ | AI_BAI_ZONE:OnBeforeAccomplish(Controllable, From, Event, To) |
+
+ OnBefore Transition Handler for Event Accomplish.
+ |
+
+
+ | AI_BAI_ZONE:OnBeforeDestroy(Controllable, From, Event, To) |
+
+ OnBefore Transition Handler for Event Destroy.
+ |
+
+
+ | AI_BAI_ZONE:OnBeforeEngage(Controllable, From, Event, To) |
+
+ OnBefore Transition Handler for Event Engage.
+ |
+
+
+ | AI_BAI_ZONE:OnBeforeFired(Controllable, From, Event, To) |
+
+ OnBefore Transition Handler for Event Fired.
+ |
+
+
+ | AI_BAI_ZONE:OnEnterEngaging(Controllable, From, Event, To) |
+
+ OnEnter Transition Handler for State Engaging.
+ |
+
+
+ | AI_BAI_ZONE:OnEventDead(EventData) |
+
+
+ |
+
+
+ | AI_BAI_ZONE:OnLeaveEngaging(Controllable, From, Event, To) |
+
+ OnLeave Transition Handler for State Engaging.
+ |
+
+
+ | AI_BAI_ZONE:SetEngageZone(EngageZone) |
+
+ Set the Engage Zone where the AI is performing BOMB.
+ |
+
+
+ | AI_BAI_ZONE.TargetZone |
+
+ The Zone where the patrol needs to be executed.
+ |
+
+
+ | AI_BAI_ZONE:__Abort(Delay) |
+
+ Asynchronous Event Trigger for Event Abort.
+ |
+
+
+ | AI_BAI_ZONE:__Accomplish(Delay) |
+
+ Asynchronous Event Trigger for Event Accomplish.
+ |
+
+
+ | AI_BAI_ZONE:__Destroy(Delay) |
+
+ Asynchronous Event Trigger for Event Destroy.
+ |
+
+
+ | AI_BAI_ZONE:__Engage(Delay, EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection) |
+
+ Asynchronous Event Trigger for Event Engage.
+ |
+
+
+ | AI_BAI_ZONE:__Fired(Delay) |
+
+ Asynchronous Event Trigger for Event Fired.
+ |
+
+
+ | AI_BAI_ZONE:onafterAbort(Controllable, From, Event, To) |
+
+
+ |
+
+
+ | AI_BAI_ZONE:onafterAccomplish(Controllable, From, Event, To) |
+
+
+ |
+
+
+ | AI_BAI_ZONE:onafterDestroy(Controllable, From, Event, To, EventData) |
+
+
+ |
+
+
+ | AI_BAI_ZONE:onafterEngage(Controllable, From, Event, To, EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection) |
+
+
+ |
+
+
+ | AI_BAI_ZONE:onafterStart(Controllable, From, Event, To) |
+
+ onafter State Transition for Event Start.
+ |
+
+
+ | AI_BAI_ZONE:onafterTarget(Controllable, From, Event, To) |
+
+
+ |
+
+
+ | AI_BAI_ZONE:onbeforeEngage(Controllable, From, Event, To) |
+
+
+ |
+
+
+
+
Global(s)
+
+-
+
+ #AI_BAI_ZONE
+
+AI_BAI_ZONE
+
+
+-
+
+
+
+
AIBAIZONE derives from the AIPatrol#AIPATROL_ZONE, inheriting its methods and behaviour.
+
+
+
+The AIBAIZONE class implements the core functions to provide BattleGround Air Interdiction in an Engage Zone by an AIR Controllable or Group.
+The AIBAIZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.
+
+
+
+The AIBAIZONE is assigned a Group and this must be done before the AIBAIZONE process can be started through the Start event.
+
+
+
+Upon started, The AI will Route itself towards the random 3D point within a patrol zone,
+using a random speed within the given altitude and speed limits.
+Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
+This cycle will continue until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+
+
+
+When the AI is commanded to provide BattleGround Air Interdiction (through the event Engage), the AI will fly towards the Engage Zone.
+Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.
+
+
+
+The AI will detect the targets and will only destroy the targets within the Engage Zone.
+
+
+
+Every target that is destroyed, is reported< by the AI.
+
+
+
+Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone.
+
+
+
+Until it is notified through the event Accomplish, which is to be triggered by an observing party:
+
+
+ - a FAC
+ - a timed event
+ - a menu option selected by a human
+ - a condition
+ - others ...
+
+
+
+
+When the AI has accomplished the BOMB, it will fly back to the Patrol Zone.
+
+
+
+It will keep patrolling there, until it is notified to RTB or move to another BOMB Zone.
+It can be notified to go RTB through the RTB event.
+
+When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+
+
+
+1. AIBAIZONE constructor
+
+
+
+2. AIBAIZONE is a FSM
+
+
+
+2.1. AIBAIZONE States
+
+
+ - None ( Group ): The process is not started yet.
+ - Patrolling ( Group ): The AI is patrolling the Patrol Zone.
+ - Engaging ( Group ): The AI is engaging the targets in the Engage Zone, executing BOMB.
+ - Returning ( Group ): The AI is returning to Base..
+
+
+2.2. AIBAIZONE Events
+
+
+
+
+
+
+
+
+
+-
+
+
+_NewEngageRoute(AIControllable)
+
+
+-
+
+
+
+
Parameter
+
+
+
+
+
+
+
+
AIBAIZONE class
+
+
Field(s)
+
+-
+
+ Wrapper.Controllable#CONTROLLABLE
+
+AI_BAI_ZONE.AIControllable
+
+
+-
+
+
The Controllable patrolling.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:Abort()
+
+
+-
+
+
Synchronous Event Trigger for Event Abort.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:Accomplish()
+
+
+-
+
+
Synchronous Event Trigger for Event Accomplish.
+
+
+
+
+-
+
+ #boolean
+
+AI_BAI_ZONE.Accomplished
+
+
+-
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:Destroy()
+
+
+-
+
+
Synchronous Event Trigger for Event Destroy.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:Engage(EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection)
+
+
+-
+
+
Synchronous Event Trigger for Event Engage.
+
+ Parameters
+
+ -
+
+
#number EngageSpeed :
+(optional) The speed the Group will hold when engaging to the target zone.
+
+
+ -
+
+
Dcs.DCSTypes#Distance EngageAltitude :
+(optional) Desired altitude to perform the unit engagement.
+
+
+ -
+
+
Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend :
+(optional) Determines how much weapon will be released at each attack.
+If parameter is not defined the unit / controllable will choose expend on its own discretion.
+Use the structure DCSTypes#AI.Task.WeaponExpend to define the amount of weapons to be release at each attack.
+
+
+ -
+
+
#number EngageAttackQty :
+(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+
+
+ -
+
+
Dcs.DCSTypes#Azimuth EngageDirection :
+(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE.EngageAltitude
+
+
+-
+
+
+
+
+
+
+-
+
+
+
+AI_BAI_ZONE.EngageAttackQty
+
+
+-
+
+
+
+
+
+
+-
+
+
+
+AI_BAI_ZONE.EngageDirection
+
+
+-
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE.EngageSpeed
+
+
+-
+
+
+
+
+
+
+-
+
+
+
+AI_BAI_ZONE.EngageWeaponExpend
+
+
+-
+
+
+
+
+
+
+-
+
+
+
+AI_BAI_ZONE.EngageZone
+
+
+-
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:Fired()
+
+
+-
+
+
Synchronous Event Trigger for Event Fired.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageZone, PatrolAltType)
+
+
+-
+
+
Creates a new AIBAIZONE object
+
+ Parameters
+
+ Return value
+
+#AIBAIZONE:
+self
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnAfterAbort(Controllable, From, Event, To)
+
+
+-
+
+
OnAfter Transition Handler for Event Abort.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnAfterAccomplish(Controllable, From, Event, To)
+
+
+-
+
+
OnAfter Transition Handler for Event Accomplish.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnAfterDestroy(Controllable, From, Event, To)
+
+
+-
+
+
OnAfter Transition Handler for Event Destroy.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnAfterEngage(Controllable, From, Event, To)
+
+
+-
+
+
OnAfter Transition Handler for Event Engage.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnAfterFired(Controllable, From, Event, To)
+
+
+-
+
+
OnAfter Transition Handler for Event Fired.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnBeforeAbort(Controllable, From, Event, To)
+
+
+-
+
+
OnBefore Transition Handler for Event Abort.
+
+ 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.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnBeforeAccomplish(Controllable, From, Event, To)
+
+
+-
+
+
OnBefore Transition Handler for Event Accomplish.
+
+ 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.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnBeforeDestroy(Controllable, From, Event, To)
+
+
+-
+
+
OnBefore Transition Handler for Event Destroy.
+
+ 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.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnBeforeEngage(Controllable, From, Event, To)
+
+
+-
+
+
OnBefore Transition Handler for Event Engage.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnBeforeFired(Controllable, From, Event, To)
+
+
+-
+
+
OnBefore Transition Handler for Event Fired.
+
+ 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.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnEnterEngaging(Controllable, From, Event, To)
+
+
+-
+
+
OnEnter Transition Handler for State Engaging.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnEventDead(EventData)
+
+
+-
+
+
+
+
Parameter
+
+
+
+
+-
+
+
+AI_BAI_ZONE:OnLeaveEngaging(Controllable, From, Event, To)
+
+
+-
+
+
OnLeave Transition Handler for State Engaging.
+
+ 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.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:SetEngageZone(EngageZone)
+
+
+-
+
+
Set the Engage Zone where the AI is performing BOMB.
+
+
+Note that if the EngageZone is changed, the AI needs to re-detect targets.
+
+ Parameter
+
+ Return value
+
+#AIBAIZONE:
+self
+
+
+
+
+-
+
+ Core.Zone#ZONE_BASE
+
+AI_BAI_ZONE.TargetZone
+
+
+-
+
+
The Zone where the patrol needs to be executed.
+
+
+
+
+-
+
+
+AI_BAI_ZONE:__Abort(Delay)
+
+
+-
+
+
Asynchronous Event Trigger for Event Abort.
+
+ Parameter
+
+
+
+
+-
+
+
+AI_BAI_ZONE:__Accomplish(Delay)
+
+
+-
+
+
Asynchronous Event Trigger for Event Accomplish.
+
+ Parameter
+
+
+
+
+-
+
+
+AI_BAI_ZONE:__Destroy(Delay)
+
+
+-
+
+
Asynchronous Event Trigger for Event Destroy.
+
+ Parameter
+
+
+
+
+-
+
+
+AI_BAI_ZONE:__Engage(Delay, EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection)
+
+
+-
+
+
Asynchronous Event Trigger for Event Engage.
+
+ Parameters
+
+ -
+
+
#number Delay :
+The delay in seconds.
+
+
+ -
+
+
#number EngageSpeed :
+(optional) The speed the Group will hold when engaging to the target zone.
+
+
+ -
+
+
Dcs.DCSTypes#Distance EngageAltitude :
+(optional) Desired altitude to perform the unit engagement.
+
+
+ -
+
+
Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend :
+(optional) Determines how much weapon will be released at each attack.
+If parameter is not defined the unit / controllable will choose expend on its own discretion.
+Use the structure DCSTypes#AI.Task.WeaponExpend to define the amount of weapons to be release at each attack.
+
+
+ -
+
+
#number EngageAttackQty :
+(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+
+
+ -
+
+
Dcs.DCSTypes#Azimuth EngageDirection :
+(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:__Fired(Delay)
+
+
+-
+
+
Asynchronous Event Trigger for Event Fired.
+
+ Parameter
+
+
+
+
+-
+
+
+AI_BAI_ZONE:onafterAbort(Controllable, From, Event, To)
+
+
+-
+
+
+
+
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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:onafterAccomplish(Controllable, From, Event, To)
+
+
+-
+
+
+
+
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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:onafterDestroy(Controllable, From, Event, To, EventData)
+
+
+-
+
+
+
+
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.
+
+
+ -
+
+
Core.Event#EVENTDATA EventData :
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:onafterEngage(Controllable, From, Event, To, EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection)
+
+
+-
+
+
+
+
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.
+
+
+ -
+
+
#number EngageSpeed :
+(optional) The speed the Group will hold when engaging to the target zone.
+
+
+ -
+
+
Dcs.DCSTypes#Distance EngageAltitude :
+(optional) Desired altitude to perform the unit engagement.
+
+
+ -
+
+
Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend :
+(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.
+
+
+ -
+
+
#number EngageAttackQty :
+(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+
+
+ -
+
+
Dcs.DCSTypes#Azimuth EngageDirection :
+(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:onafterStart(Controllable, From, Event, To)
+
+
+-
+
+
onafter State Transition for Event Start.
+
+ 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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:onafterTarget(Controllable, From, Event, To)
+
+
+-
+
+
+
+
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.
+
+
+
+
+
+
+-
+
+
+AI_BAI_ZONE:onbeforeEngage(Controllable, From, Event, To)
+
+
+-
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html
index 230ca6776..8230fd694 100644
--- a/docs/Documentation/AI_Balancer.html
+++ b/docs/Documentation/AI_Balancer.html
@@ -17,6 +17,7 @@
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -212,12 +213,24 @@
CARGO.Containable |
This flag defines if the cargo can be contained within a DCS Unit.
+ |
+
+
+ | CARGO:GetCoordinate() |
+
+ Get the current coordinates of the Cargo.
|
| CARGO:GetName() |
Get the name of the Cargo.
+ |
+
+
+ | CARGO:GetObjectName() |
+
+ Get the object name of the Cargo.
|
@@ -230,6 +243,12 @@
| CARGO:GetType() |
Get the type of the Cargo.
+ |
+
+
+ | CARGO:IsAlive() |
+
+ Check if cargo is alive.
|
@@ -432,6 +451,12 @@
| CARGO_GROUP:New(CargoGroup, Type, Name, ReportRadius, NearRadius) |
CARGO_GROUP constructor.
+ |
+
+
+ | CARGO_GROUP:onafterBoarding(CargoCarrier, Event, From, To, NearRadius, ...) |
+
+ Leave Boarding State.
|
@@ -462,12 +487,6 @@
| CARGO_GROUP:onenterUnLoaded(Core, Event, From, To, ToPointVec2, ...) |
Enter UnLoaded State.
- |
-
-
- | CARGO_GROUP:onleaveBoarding(CargoCarrier, Event, From, To, NearRadius, ...) |
-
- Leave Boarding State.
|
@@ -652,6 +671,12 @@
| CARGO_UNIT.OnUnLoadedCallBack |
+ |
+
+
+ | CARGO_UNIT.RunCount |
+
+
|
@@ -694,12 +719,6 @@
| CARGO_UNIT:onenterUnLoaded(Event, From, To, Core, ToPointVec2) |
Enter UnLoaded State.
- |
-
-
- | CARGO_UNIT:onleaveBoarding(Event, From, To, CargoCarrier, NearRadius, ...) |
-
- Leave Boarding State.
|
@@ -964,6 +983,24 @@ The radius when the cargo will board the Carrier (to avoid collision).
-
+
+CARGO:GetCoordinate()
+
+
+-
+
+
Get the current coordinates of the Cargo.
+
+ Return value
+
+Core.Point#COORDINATE:
+The coordinates of the Cargo.
+
+
+
+
+-
+
CARGO:GetName()
@@ -982,6 +1019,24 @@ The name of the Cargo.
-
+
+CARGO:GetObjectName()
+
+
+-
+
+
Get the object name of the Cargo.
+
+ Return value
+
+#string:
+The object name of the Cargo.
+
+
+
+
+-
+
CARGO:GetPointVec2()
@@ -1018,6 +1073,24 @@ The type of the Cargo.
-
+
+CARGO:IsAlive()
+
+
+-
+
+
Check if cargo is alive.
+
+ Return value
+
+#boolean:
+true if unloaded
+
+
+
+
+-
+
CARGO:IsInZone(Zone)
@@ -1809,6 +1882,52 @@ The amount of seconds to delay the action.
-
+
+CARGO_GROUP:onafterBoarding(CargoCarrier, Event, From, To, NearRadius, ...)
+
+
+-
+
+
Leave Boarding State.
+
+ Parameters
+
+
+
+
+-
+
CARGO_GROUP:onafterUnBoarding(ToPointVec2, Event, From, To, NearRadius, ...)
@@ -2035,52 +2154,6 @@ Point#POINT_VEC2
-
-
-CARGO_GROUP:onleaveBoarding(CargoCarrier, Event, From, To, NearRadius, ...)
-
-
--
-
-
Leave Boarding State.
-
- Parameters
-
-
-
-
--
-
CARGO_GROUP:onleaveUnBoarding(ToPointVec2, Event, From, To, NearRadius, ...)
@@ -2847,7 +2920,6 @@ The range till cargo will board.
-
-
CARGO_UNIT.CargoCarrier
@@ -2968,6 +3040,20 @@ The range till cargo will board.
+
+
+
+-
+
+ #number
+
+CARGO_UNIT.RunCount
+
+
+-
+
+
+
@@ -3271,52 +3357,6 @@ Point#POINT_VEC2
-
-
-CARGO_UNIT:onleaveBoarding(Event, From, To, CargoCarrier, NearRadius, ...)
-
-
--
-
-
Leave Boarding State.
-
- Parameters
-
-
-
-
--
-
CARGO_UNIT:onleaveUnBoarding(Event, From, To, ToPointVec2, NearRadius)
diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html
index 90607d917..3e5471b7e 100644
--- a/docs/Documentation/CleanUp.html
+++ b/docs/Documentation/CleanUp.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html
index f28f29238..472bbe443 100644
--- a/docs/Documentation/Client.html
+++ b/docs/Documentation/Client.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html
index 7b2d84919..bcf88684a 100644
--- a/docs/Documentation/CommandCenter.html
+++ b/docs/Documentation/CommandCenter.html
@@ -17,6 +17,7 @@
index
- | COMMANDCENTER:ReportSummary(ReportGroup) |
+ COMMANDCENTER:ReportMissionsPlayers(ReportGroup) |
+
+ Report the players of all MISSIONs to a GROUP.
+ |
+
+
+ | COMMANDCENTER:ReportMissionsStatus(ReportGroup) |
Report the status of all MISSIONs to a GROUP.
|
@@ -737,8 +744,32 @@ Group#GROUP
-
-
-COMMANDCENTER:ReportSummary(ReportGroup)
+
+COMMANDCENTER:ReportMissionsPlayers(ReportGroup)
+
+
+-
+
+
Report the players of all MISSIONs to a GROUP.
+
+
+Each Mission is listed, with an indication how many Tasks are still to be completed.
+
+ Parameter
+
+ -
+
+
ReportGroup :
+
+
+
+
+
+
+-
+
+
+COMMANDCENTER:ReportMissionsStatus(ReportGroup)
-
diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html
index ad27bec5c..2d445d50e 100644
--- a/docs/Documentation/Controllable.html
+++ b/docs/Documentation/Controllable.html
@@ -17,6 +17,7 @@
index
- | CONTROLLABLE:TaskBombing(Vec2, WeaponType, WeaponExpend, AttackQty, Direction, ControllableAttack) |
+ CONTROLLABLE:TaskBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, WeaponType) |
(AIR) Delivering weapon at the point on the ground.
|
@@ -2220,7 +2221,7 @@ The DCS task structure.
-
-CONTROLLABLE:TaskBombing(Vec2, WeaponType, WeaponExpend, AttackQty, Direction, ControllableAttack)
+CONTROLLABLE:TaskBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, WeaponType)
-
@@ -2237,8 +2238,8 @@ The DCS task structure.
-
-
#number WeaponType :
-(optional) Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.
+#boolean GroupAttack :
+(optional) Flag indicates that the target must be engaged by all aircrafts of the group. Has effect only if the task is assigned to a group, not to a single aircraft.
-
@@ -2261,8 +2262,8 @@ The DCS task structure.
-
-
#boolean ControllableAttack :
-(optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a controllable, not to a single aircraft.
+#number WeaponType :
+(optional) Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.
diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html
index 01bc9464a..f9b40732f 100644
--- a/docs/Documentation/DCSAirbase.html
+++ b/docs/Documentation/DCSAirbase.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html
index bb7ebcfcb..5d9721659 100644
--- a/docs/Documentation/DCSCoalitionObject.html
+++ b/docs/Documentation/DCSCoalitionObject.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html
index 91c30c853..918aba934 100644
--- a/docs/Documentation/DCSCommand.html
+++ b/docs/Documentation/DCSCommand.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html
index 1e5034deb..c8f091a16 100644
--- a/docs/Documentation/DCSController.html
+++ b/docs/Documentation/DCSController.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html
index fa9675c4a..f5cf0300e 100644
--- a/docs/Documentation/DCSGroup.html
+++ b/docs/Documentation/DCSGroup.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html
index ef4007524..aa771f73d 100644
--- a/docs/Documentation/DCSObject.html
+++ b/docs/Documentation/DCSObject.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html
index 49ee84e3f..bdab8ced8 100644
--- a/docs/Documentation/DCSTask.html
+++ b/docs/Documentation/DCSTask.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html
index 89bfc6f76..68b115ab2 100644
--- a/docs/Documentation/DCSTypes.html
+++ b/docs/Documentation/DCSTypes.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html
index dd2ee830e..ff49c3ce0 100644
--- a/docs/Documentation/DCSUnit.html
+++ b/docs/Documentation/DCSUnit.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html
index b774c20dd..bae815190 100644
--- a/docs/Documentation/DCSVec3.html
+++ b/docs/Documentation/DCSVec3.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html
index 14dffe7a6..8cf46e3e9 100644
--- a/docs/Documentation/DCSWorld.html
+++ b/docs/Documentation/DCSWorld.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html
index 1ca1e8eaf..dcfed9d0f 100644
--- a/docs/Documentation/DCSZone.html
+++ b/docs/Documentation/DCSZone.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html
index 2918281ca..3513b9812 100644
--- a/docs/Documentation/DCScountry.html
+++ b/docs/Documentation/DCScountry.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html
index 70c8b9c64..1822b7fbc 100644
--- a/docs/Documentation/DCStimer.html
+++ b/docs/Documentation/DCStimer.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html
index ec6e651a8..0a12a11e5 100644
--- a/docs/Documentation/DCStrigger.html
+++ b/docs/Documentation/DCStrigger.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html
index bdaa3f280..13c610e53 100644
--- a/docs/Documentation/Database.html
+++ b/docs/Documentation/Database.html
@@ -17,6 +17,7 @@
index
+
+ | DATABASE.UNITS_Index |
+
+
+ |
+
+
+ | DATABASE.UNITS_Position |
+
+
|
@@ -1797,6 +1810,33 @@ self
+
+
+
+-
+
+
+
+DATABASE.UNITS_Index
+
+
+-
+
+
+
+
+
+
+-
+
+
+DATABASE.UNITS_Position
+
+
+-
+
+
+
diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html
index 0b38068a2..10ff4c243 100644
--- a/docs/Documentation/Designate.html
+++ b/docs/Documentation/Designate.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -890,7 +891,6 @@ function below will use the range 1-7 just in case
-
-
DESIGNATE.LaserCodes
diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html
index 4514b29c5..e512594d8 100644
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -2322,7 +2323,6 @@ The index of the DetectedItem.
-
- #number
DETECTION_BASE.DetectedItemCount
diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html
index 69181e750..b5aea1316 100644
--- a/docs/Documentation/DetectionManager.html
+++ b/docs/Documentation/DetectionManager.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html
index d1e785017..a43ecab35 100644
--- a/docs/Documentation/Escort.html
+++ b/docs/Documentation/Escort.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html
index b43313153..bfa3823de 100644
--- a/docs/Documentation/Event.html
+++ b/docs/Documentation/Event.html
@@ -17,6 +17,7 @@
index
+
+ | EVENT:CreateEventPlayerEnterUnit(PlayerUnit) |
+
+ Creation of a SEVENTPLAYERENTERUNIT Event.
|
@@ -1009,6 +1016,27 @@ The Cargo created.
+
+
+-
+
+
+EVENT:CreateEventPlayerEnterUnit(PlayerUnit)
+
+
+-
+
+
Creation of a SEVENTPLAYERENTERUNIT Event.
+
+ Parameter
+
+
-
diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html
index 425da196e..b832094de 100644
--- a/docs/Documentation/Fsm.html
+++ b/docs/Documentation/Fsm.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -1622,7 +1623,7 @@ A string defining the start state.
-
- #string
+
FSM._StartState
@@ -1921,6 +1922,7 @@ A string defining the start state.
-
+
FSM.current
diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html
index 9f0a9032c..d970725e0 100644
--- a/docs/Documentation/Group.html
+++ b/docs/Documentation/Group.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html
index 09726bbec..c049a8f65 100644
--- a/docs/Documentation/Identifiable.html
+++ b/docs/Documentation/Identifiable.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html
index a108b8568..f294044d9 100644
--- a/docs/Documentation/Menu.html
+++ b/docs/Documentation/Menu.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html
index 0b06cafbb..3d8c4d78f 100644
--- a/docs/Documentation/Message.html
+++ b/docs/Documentation/Message.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html
index 163c4d7fb..88159742b 100644
--- a/docs/Documentation/MissileTrainer.html
+++ b/docs/Documentation/MissileTrainer.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html
index 96f09fc56..fa18d7ec0 100644
--- a/docs/Documentation/Mission.html
+++ b/docs/Documentation/Mission.html
@@ -17,6 +17,7 @@
index
+
+ | MISSION.AssignedGroups |
+
+
|
| MISSION.ClassName |
+ |
+
+
+ | MISSION:ClearGroupAssignment(MissionGroup) |
+
+ Clear the Group assignment from the Mission.
|
@@ -194,6 +207,12 @@ A CLIENT needs to be registered within the MISSION.GetTask(TaskName, self)
|
Get the TASK identified by the TaskNumber from the Mission.
+ |
+
+
+ | MISSION:GetTaskTypes() |
+
+
|
@@ -230,6 +249,12 @@ A CLIENT needs to be registered within the MISSION:IsFAILED()
|
Is the Mission FAILED.
+ |
+
+
+ | MISSION:IsGroupAssigned(MissionGroup) |
+
+ Returns if the Mission is assigned to the Group.
|
@@ -416,6 +441,18 @@ A CLIENT needs to be registered within the MISSION:ReportOverview(TaskStatus)
|
Create a overview report of the Mission (multiple lines).
+ |
+
+
+ | MISSION:ReportPlayers() |
+
+ Create a player report of the Mission.
+ |
+
+
+ | MISSION:ReportStatus() |
+
+ Create a status report of the Mission.
|
@@ -428,6 +465,12 @@ A CLIENT needs to be registered within the MISSION.Scoring
|
+ |
+
+
+ | MISSION:SetGroupAssigned(MissionGroup) |
+
+ Set Group assigned to the Mission.
|
@@ -541,8 +584,8 @@ The CLIENT or UNIT of the Player joining the Mission.
Return value
-#boolean:
-true if Unit is part of a Task in the Mission.
+#MISSION:
+
@@ -601,6 +644,20 @@ is the Task object.
Tasking.Task#TASK:
The task added.
+
+
+
+-
+
+
+
+MISSION.AssignedGroups
+
+
+-
+
+
+
@@ -615,6 +672,32 @@ The task added.
+
+
+
+-
+
+
+MISSION:ClearGroupAssignment(MissionGroup)
+
+
+-
+
+
Clear the Group assignment from the Mission.
+
+ Parameter
+
+ Return value
+
+#MISSION:
+
+
@@ -657,8 +740,8 @@ The CLIENT or UNIT of the Player crashing.
Return value
-#boolean:
-true if Unit is part of a Task in the Mission.
+#MISSION:
+
@@ -840,6 +923,24 @@ Returns nil if no task was found.
-
+
+MISSION:GetTaskTypes()
+
+
+-
+
+
+
+
Return value
+
+#number:
+
+
+
+
+
+-
+
MISSION:GetTasks()
@@ -970,6 +1071,32 @@ true if the Mission has a Group.
#boolean:
+
+
+
+-
+
+
+MISSION:IsGroupAssigned(MissionGroup)
+
+
+-
+
+
Returns if the Mission is assigned to the Group.
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
@@ -1907,6 +2034,67 @@ self
#string:
+
+
+
+-
+
+
+MISSION:ReportPlayers()
+
+
+-
+
+
Create a player report of the Mission.
+
+
+This reports provides a one liner of the mission status. It indicates how many players and how many Tasks.
+
+Mission "<MissionName>" - Status "<MissionStatus>"
+ - Player "<PlayerName>: Task <TaskName> <TaskStatus>, Task <TaskName> <TaskStatus>
+ - Player <PlayerName>: Task <TaskName> <TaskStatus>, Task <TaskName> <TaskStatus>
+ - ..
+
+
+
+ Return value
+
+#string:
+
+
+
+
+
+-
+
+
+MISSION:ReportStatus()
+
+
+-
+
+
Create a status report of the Mission.
+
+
+This reports provides a one liner of the mission status. It indicates how many players and how many Tasks.
+
+Mission "<MissionName>" - Status "<MissionStatus>"
+ - Task Types: <TaskType>, <TaskType>
+ - <xx> Planned Tasks (xp)
+ - <xx> Assigned Tasks(xp)
+ - <xx> Success Tasks (xp)
+ - <xx> Hold Tasks (xp)
+ - <xx> Cancelled Tasks (xp)
+ - <xx> Aborted Tasks (xp)
+ - <xx> Failed Tasks (xp)
+
+
+
+ Return value
+
+#string:
+
+
@@ -1939,6 +2127,32 @@ self
+
+
+
+-
+
+
+MISSION:SetGroupAssigned(MissionGroup)
+
+
+-
+
+
Set Group assigned to the Mission.
+
+ Parameter
+
+ Return value
+
+#MISSION:
+
+
diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html
index a7de96e12..3adb3bd89 100644
--- a/docs/Documentation/Movement.html
+++ b/docs/Documentation/Movement.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html
index eb4b6b090..63145ee4b 100644
--- a/docs/Documentation/Object.html
+++ b/docs/Documentation/Object.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html
index c2551b2fa..d487eeafe 100644
--- a/docs/Documentation/Point.html
+++ b/docs/Documentation/Point.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -1971,6 +1972,7 @@ The new calculated POINT_VEC2.
-
+
POINT_VEC2.z
diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html
index 750f76f48..d9dea20e8 100644
--- a/docs/Documentation/Positionable.html
+++ b/docs/Documentation/Positionable.html
@@ -17,6 +17,7 @@
index
- | POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition, Name) |
+ POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition) |
Send a message to a coalition.
|
@@ -1184,7 +1185,7 @@ The client object receiving the message.
-
-POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition, Name)
+POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition)
-
@@ -1213,12 +1214,6 @@ The duration of the message.
Dcs.DCScoalition#coalition MessageCoalition :
The Coalition receiving the message.
-
- -
-
-
#string Name :
-(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
-
diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html
index 2f5617745..9e073a5a6 100644
--- a/docs/Documentation/Process_JTAC.html
+++ b/docs/Documentation/Process_JTAC.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html
index f3c04bde3..20b6065b6 100644
--- a/docs/Documentation/Process_Pickup.html
+++ b/docs/Documentation/Process_Pickup.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html
index 49e33bb80..74bfa4e8c 100644
--- a/docs/Documentation/Radio.html
+++ b/docs/Documentation/Radio.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html
index 4baad755b..4b4f79333 100644
--- a/docs/Documentation/Route.html
+++ b/docs/Documentation/Route.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html
index e67b955d0..114319f43 100644
--- a/docs/Documentation/Scenery.html
+++ b/docs/Documentation/Scenery.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html
index e64ef01f1..c5292e224 100644
--- a/docs/Documentation/ScheduleDispatcher.html
+++ b/docs/Documentation/ScheduleDispatcher.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html
index e995868a6..7981b1438 100644
--- a/docs/Documentation/Scheduler.html
+++ b/docs/Documentation/Scheduler.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html
index 9df3c05db..322b24998 100644
--- a/docs/Documentation/Scoring.html
+++ b/docs/Documentation/Scoring.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html
index 9dcd22068..dbf3167ec 100644
--- a/docs/Documentation/Sead.html
+++ b/docs/Documentation/Sead.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html
index fee8d1931..56e79058a 100644
--- a/docs/Documentation/Set.html
+++ b/docs/Documentation/Set.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -976,6 +977,12 @@ mission designer to add a dedicated method
Iterate the SET_UNIT sorted *per Threat Level and call an interator function for each alive UNIT, providing the UNIT and optional parameters.
+ |
+
+
+ | SET_UNIT:GetFirst() |
+
+ Get the first unit from the set.
|
@@ -4817,6 +4824,24 @@ self
-
+
+SET_UNIT:GetFirst()
+
+
+-
+
+
Get the first unit from the set.
+
+ Return value
+
+Wrapper.Unit#UNIT:
+The UNIT object.
+
+
+
+
+-
+
SET_UNIT:GetTypeNames(Delimiter)
diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html
index c59546f49..136d8ac61 100644
--- a/docs/Documentation/Smoke.html
+++ b/docs/Documentation/Smoke.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html
index 05374facf..6bbc5b660 100644
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@@ -17,6 +17,7 @@
index
@@ -2541,6 +2545,9 @@ when nothing was spawned.
+
+ By default, no InitLimit
+
@@ -2576,7 +2583,7 @@ when nothing was spawned.
-
-
+ #number
SPAWN.SpawnMaxGroups
@@ -2593,7 +2600,7 @@ when nothing was spawned.
-
-
+ #number
SPAWN.SpawnMaxUnitsAlive
diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html
index aac7b1703..d1a622752 100644
--- a/docs/Documentation/SpawnStatic.html
+++ b/docs/Documentation/SpawnStatic.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -444,7 +445,6 @@ ptional) The name of the new static.
-
- #number
SPAWNSTATIC.SpawnIndex
diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html
index 8e9ea64bc..acc195246 100644
--- a/docs/Documentation/Spot.html
+++ b/docs/Documentation/Spot.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -761,6 +762,7 @@ true if it is lasing
-
+
SPOT.ScheduleID
@@ -774,6 +776,7 @@ true if it is lasing
-
+
SPOT.SpotIR
@@ -787,6 +790,7 @@ true if it is lasing
-
+
SPOT.SpotLaser
@@ -800,6 +804,7 @@ true if it is lasing
-
+
SPOT.Target
diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html
index 48567e339..ffa9fdb0e 100644
--- a/docs/Documentation/Static.html
+++ b/docs/Documentation/Static.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html
index 40915b9d3..b8eff3eed 100644
--- a/docs/Documentation/StaticObject.html
+++ b/docs/Documentation/StaticObject.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html
index 87c1f6f63..32e192c3f 100644
--- a/docs/Documentation/Task.html
+++ b/docs/Documentation/Task.html
@@ -17,6 +17,7 @@
index
- | TASK:AbortUnit(PlayerUnit) |
+ TASK:AbortGroup(PlayerUnit, PlayerGroup) |
Abort a PlayerUnit from a Task.
|
@@ -148,6 +149,12 @@
TASK:Cancel() |
FSM Cancel synchronous event function for TASK.
+ |
+
+
+ | TASK:ClearGroupAssignment(TaskGroup) |
+
+ Clear the Group assignment from the Task.
|
@@ -157,7 +164,7 @@
- | TASK:CrashUnit(PlayerUnit) |
+ TASK:CrashGroup(PlayerUnit, PlayerGroup) |
A PlayerUnit crashed in a Task.
|
@@ -184,6 +191,12 @@
TASK.FsmTemplate |
+ |
+
+
+ | TASK:GetBriefing() |
+
+ Gets the Task briefing.
|
@@ -208,6 +221,18 @@
| TASK:GetName() |
Gets the Name of the Task
+ |
+
+
+ | TASK:GetPlayerCount() |
+
+ Create a count of the players in the Task.
+ |
+
+
+ | TASK:GetPlayerNames() |
+
+ Create a list of the players in the Task.
|
@@ -232,6 +257,12 @@
| TASK:GetStateString() |
Gets the Task status.
+ |
+
+
+ | TASK:GetTaskBriefing() |
+
+ Returns the Task briefing.
|
@@ -277,7 +308,7 @@
- | TASK:IsAssignedToGroup(TaskGroup) |
+ TASK:IsGroupAssigned(TaskGroup) |
Returns if the Task is assigned to the Group.
|
@@ -367,7 +398,7 @@
- | TASK:New(Mission, SetGroupAssign, TaskName, TaskType) |
+ TASK:New(Mission, SetGroupAssign, TaskName, TaskType, TaskBriefing) |
Instantiates a new TASK.
|
@@ -388,6 +419,12 @@
TASK:OnAfterPlayerDead(PlayerUnit, PlayerName) |
FSM PlayerDead event handler prototype for TASK.
+ |
+
+
+ | TASK:RefreshMenus(TaskGroup, MenuTime) |
+
+ Remove the menu option of the Task for a Group.
|
@@ -400,12 +437,6 @@
| TASK:RemoveMenu(MenuTime) |
Remove the menu options of the Task to all the groups in the SetGroup.
- |
-
-
- | TASK:RemovePlannedMenuForGroup(TaskGroup, MenuTime) |
-
- Remove the menu option of the Task for a Group.
|
@@ -466,6 +497,12 @@
| TASK.SetGroup |
The Set of Groups assigned to the Task
+ |
+
+
+ | TASK:SetGroupAssigned(TaskGroup) |
+
+ Set Group assigned to the Task.
|
@@ -805,8 +842,8 @@ Use the method TASK.AddScore() to add scores whe
-
-
-TASK:AbortUnit(PlayerUnit)
+
+TASK:AbortGroup(PlayerUnit, PlayerGroup)
-
@@ -817,19 +854,24 @@ Use the method TASK.AddScore() to add scores whe
If the Unit was not part of the Task, false is returned.
If the Unit is part of the Task, true is returned.
- Parameter
+ Parameters
Return value
-#boolean:
-true if Unit is part of the Task.
+#TASK:
+
@@ -899,6 +941,32 @@ self
Use this event to Cancel the Task.
+
+
+
+-
+
+
+TASK:ClearGroupAssignment(TaskGroup)
+
+
+-
+
+
Clear the Group assignment from the Task.
+
+ Parameter
+
+ Return value
+
+#TASK:
+
+
@@ -918,8 +986,8 @@ self
-
-
-TASK:CrashUnit(PlayerUnit)
+
+TASK:CrashGroup(PlayerUnit, PlayerGroup)
-
@@ -931,19 +999,24 @@ self
If the Unit was not part of the Task, false is returned.
If the Unit is part of the Task, true is returned.
-
Parameter
+ Parameters
Return value
-#boolean:
-true if Unit is part of the Task.
+#TASK:
+
@@ -1017,6 +1090,24 @@ true if Unit is part of the Task.
+
+
+
+-
+
+
+TASK:GetBriefing()
+
+
+-
+
+
Gets the Task briefing.
+
+ Return value
+
+#string:
+The briefing text.
+
@@ -1094,6 +1185,42 @@ The Task Name
-
+
+TASK:GetPlayerCount()
+
+
+-
+
+
Create a count of the players in the Task.
+
+ Return value
+
+#number:
+The total number of players in the task.
+
+
+
+
+-
+
+
+TASK:GetPlayerNames()
+
+
+-
+
+
Create a list of the players in the Task.
+
+ Return value
+
+#map:
+string,Wrapper.Group#GROUP> A map of the players
+
+
+
+
+-
+
TASK:GetProcessTemplate(ProcessName)
@@ -1177,6 +1304,24 @@ Scoring
-
+
+TASK:GetTaskBriefing()
+
+
+-
+
+
Returns the Task briefing.
+
+ Return value
+
+#string:
+Task briefing.
+
+
+
+
+-
+
TASK:GetTaskIndex()
@@ -1327,8 +1472,8 @@ self
-
-
-TASK:IsAssignedToGroup(TaskGroup)
+
+TASK:IsGroupAssigned(TaskGroup)
-
@@ -1594,7 +1739,7 @@ true if Unit is part of the Task.
-
-TASK:New(Mission, SetGroupAssign, TaskName, TaskType)
+TASK:New(Mission, SetGroupAssign, TaskName, TaskType, TaskBriefing)
-
@@ -1629,6 +1774,11 @@ The name of the Task
#string TaskType :
The type of the Task
+
+ -
+
+
TaskBriefing :
+
Return value
@@ -1725,6 +1875,37 @@ The name of the Player.
-
+
+
+-
+
+
Remove the menu option of the Task for a Group.
+
+ Parameters
+
+ Return value
+
+#TASK:
+self
+
+
+
+
+-
+
@@ -1777,37 +1958,6 @@ self
#TASK:
-
-
-
--
-
-
-
--
-
-
Remove the menu option of the Task for a Group.
-
- Parameters
-
- Return value
-
-#TASK:
-self
-
@@ -2023,6 +2173,32 @@ self
The Set of Groups assigned to the Task
+
+
+
+-
+
+
+TASK:SetGroupAssigned(TaskGroup)
+
+
+-
+
+
Set Group assigned to the Task.
+
+ Parameter
+
+ Return value
+
+#TASK:
+
+
@@ -2901,6 +3077,8 @@ self
+
+
diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html
index 48a7ba5f0..fd355500d 100644
--- a/docs/Documentation/Task_A2G.html
+++ b/docs/Documentation/Task_A2G.html
@@ -17,6 +17,7 @@
index
- | TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType) |
+ TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing) |
Instantiates a new TASK_A2G.
|
@@ -304,7 +305,7 @@ The TASK_A2G is implemented using a Stat
- | TASK_BAI:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit) |
+ TASK_BAI:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing) |
Instantiates a new TASK_BAI.
|
@@ -326,7 +327,7 @@ The TASK_A2G is implemented using a Stat
- | TASK_CAS:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit) |
+ TASK_CAS:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing) |
Instantiates a new TASK_CAS.
|
@@ -348,7 +349,7 @@ The TASK_A2G is implemented using a Stat
- | TASK_SEAD:New(Mission, SetGroup, TaskName, TargetSetUnit) |
+ TASK_SEAD:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing) |
Instantiates a new TASK_SEAD.
|
@@ -572,7 +573,7 @@ The Zone object where the Target is located on the map.
-
-TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType)
+TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing)
-
@@ -625,6 +626,11 @@ If the TargetZone parameter is specified, the player will be routed to the cente
TaskType :
+
+ -
+
+
TaskBriefing :
+
Return value
@@ -900,7 +906,7 @@ The Zone object where the Target is located on the map.
-
-TASK_BAI:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit)
+TASK_BAI:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)
-
@@ -916,7 +922,7 @@ The Zone object where the Target is located on the map.
-
-
Set#SET_GROUP SetGroup :
+
Core.Set#SET_GROUP SetGroup :
The set of groups for which the Task can be assigned.
@@ -928,25 +934,13 @@ The name of the Task.
-
-
Set#SET_UNIT UnitSetTargets :
+Core.Set#SET_UNIT TargetSetUnit :
-
-
#number TargetDistance :
-The distance to Target when the Player is considered to have "arrived" at the engagement range.
-
-
- -
-
-
Core.Zone#ZONE_BASE TargetZone :
-The target zone, if known.
-If the TargetZone parameter is specified, the player will be routed to the center of the zone where all the targets are assumed to be.
-
-
- -
-
-
TargetSetUnit :
+#string TaskBriefing :
+The briefing of the task.
@@ -995,7 +989,7 @@ self
-
-TASK_CAS:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit)
+TASK_CAS:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)
-
@@ -1011,7 +1005,7 @@ self
-
-
Set#SET_GROUP SetGroup :
+
Core.Set#SET_GROUP SetGroup :
The set of groups for which the Task can be assigned.
@@ -1023,25 +1017,13 @@ The name of the Task.
-
-
Set#SET_UNIT UnitSetTargets :
+Core.Set#SET_UNIT TargetSetUnit :
-
-
#number TargetDistance :
-The distance to Target when the Player is considered to have "arrived" at the engagement range.
-
-
- -
-
-
Core.Zone#ZONE_BASE TargetZone :
-The target zone, if known.
-If the TargetZone parameter is specified, the player will be routed to the center of the zone where all the targets are assumed to be.
-
-
- -
-
-
TargetSetUnit :
+#string TaskBriefing :
+The briefing of the task.
@@ -1090,7 +1072,7 @@ self
-
-TASK_SEAD:New(Mission, SetGroup, TaskName, TargetSetUnit)
+TASK_SEAD:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)
-
@@ -1106,7 +1088,7 @@ self
-
-
Set#SET_GROUP SetGroup :
+
Core.Set#SET_GROUP SetGroup :
The set of groups for which the Task can be assigned.
@@ -1118,7 +1100,13 @@ The name of the Task.
-
-
Set#SET_UNIT TargetSetUnit :
+Core.Set#SET_UNIT TargetSetUnit :
+
+
+ -
+
+
#string TaskBriefing :
+The briefing of the task.
diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html
index 197ead2ef..54ba3cfa4 100644
--- a/docs/Documentation/Task_A2G_Dispatcher.html
+++ b/docs/Documentation/Task_A2G_Dispatcher.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html
index a05a4ee40..5cb0f06fd 100644
--- a/docs/Documentation/Task_Cargo.html
+++ b/docs/Documentation/Task_Cargo.html
@@ -17,6 +17,7 @@
index
- | TASK_CARGO:New(Mission, SetGroup, TaskName, SetCargo, TaskType) |
+ TASK_CARGO:New(Mission, SetGroup, TaskName, SetCargo, TaskType, TaskBriefing) |
Instantiates a new TASK_CARGO.
|
@@ -283,6 +284,18 @@ and various dedicated deployment zones.
+ | TASK_CARGO_TRANSPORT:CargoDeployed(TaskUnit, Cargo, DeployZone) |
+
+ Synchronous Event Trigger for Event CargoDeployed.
+ |
+
+
+ | TASK_CARGO_TRANSPORT:CargoPickedUp(TaskUnit, Cargo) |
+
+ Synchronous Event Trigger for Event CargoPickedUp.
+ |
+
+
| TASK_CARGO_TRANSPORT.ClassName |
@@ -295,9 +308,45 @@ and various dedicated deployment zones.
|
- | TASK_CARGO_TRANSPORT:New(Mission, SetGroup, TaskName, SetCargo) |
+ TASK_CARGO_TRANSPORT:New(Mission, SetGroup, TaskName, SetCargo, TaskBriefing) |
Instantiates a new TASKCARGOTRANSPORT.
+ |
+
+
+ | TASK_CARGO_TRANSPORT:OnAfterCargoDeployed(From, Event, To, TaskUnit, Cargo, DeployZone) |
+
+ OnAfter Transition Handler for Event CargoDeployed.
+ |
+
+
+ | TASK_CARGO_TRANSPORT:OnAfterCargoPickedUp(From, Event, To, TaskUnit, Cargo) |
+
+ OnAfter Transition Handler for Event CargoPickedUp.
+ |
+
+
+ | TASK_CARGO_TRANSPORT:OnBeforeCargoDeployed(From, Event, To, TaskUnit, Cargo, DeployZone) |
+
+ OnBefore Transition Handler for Event CargoDeployed.
+ |
+
+
+ | TASK_CARGO_TRANSPORT:OnBeforeCargoPickedUp(From, Event, To, TaskUnit, Cargo) |
+
+ OnBefore Transition Handler for Event CargoPickedUp.
+ |
+
+
+ | TASK_CARGO_TRANSPORT:__CargoDeployed(Delay, TaskUnit, Cargo, DeployZone) |
+
+ Asynchronous Event Trigger for Event CargoDeployed.
+ |
+
+
+ | TASK_CARGO_TRANSPORT:__CargoPickedUp(Delay, TaskUnit, Cargo) |
+
+ Asynchronous Event Trigger for Event CargoPickedUp.
|
@@ -608,7 +657,7 @@ The Zone object where the Target is located on the map.
-
-TASK_CARGO:New(Mission, SetGroup, TaskName, SetCargo, TaskType)
+TASK_CARGO:New(Mission, SetGroup, TaskName, SetCargo, TaskType, TaskBriefing)
-
@@ -645,6 +694,12 @@ The scope of the cargo to be transported.
#string TaskType :
The type of Cargo task.
+
+ -
+
+
#string TaskBriefing :
+The Cargo Task briefing.
+
Return value
@@ -936,6 +991,68 @@ The score in points.
-
+
+TASK_CARGO_TRANSPORT:CargoDeployed(TaskUnit, Cargo, DeployZone)
+
+
+-
+
+
Synchronous Event Trigger for Event CargoDeployed.
+
+ Parameters
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that Deployed the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+ -
+
+
Core.Zone#ZONE DeployZone :
+The zone where the Cargo got Deployed or UnBoarded.
+
+
+
+
+
+
+-
+
+
+TASK_CARGO_TRANSPORT:CargoPickedUp(TaskUnit, Cargo)
+
+
+-
+
+
Synchronous Event Trigger for Event CargoPickedUp.
+
+ Parameters
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+
+
+
+
+-
+
#string
TASK_CARGO_TRANSPORT.ClassName
@@ -969,7 +1086,7 @@ The score in points.
-
-TASK_CARGO_TRANSPORT:New(Mission, SetGroup, TaskName, SetCargo)
+TASK_CARGO_TRANSPORT:New(Mission, SetGroup, TaskName, SetCargo, TaskBriefing)
-
@@ -1000,6 +1117,12 @@ The name of the Task.
Core.Set#SET_CARGO SetCargo :
The scope of the cargo to be transported.
+
+ -
+
+
#string TaskBriefing :
+The Cargo Task briefing.
+
Return value
@@ -1007,6 +1130,286 @@ The scope of the cargo to be transported.
#TASKCARGOTRANSPORT:
self
+
+
+
+-
+
+
+TASK_CARGO_TRANSPORT:OnAfterCargoDeployed(From, Event, To, TaskUnit, Cargo, DeployZone)
+
+
+-
+
+
OnAfter Transition Handler for Event CargoDeployed.
+
+ Parameters
+
+ -
+
+
#string From :
+The From State string.
+
+
+ -
+
+
#string Event :
+The Event string.
+
+
+ -
+
+
#string To :
+The To State string.
+
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that Deployed the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+ -
+
+
Core.Zone#ZONE DeployZone :
+The zone where the Cargo got Deployed or UnBoarded.
+
+
+
+
+
+
+-
+
+
+TASK_CARGO_TRANSPORT:OnAfterCargoPickedUp(From, Event, To, TaskUnit, Cargo)
+
+
+-
+
+
OnAfter Transition Handler for Event CargoPickedUp.
+
+ Parameters
+
+ -
+
+
#string From :
+The From State string.
+
+
+ -
+
+
#string Event :
+The Event string.
+
+
+ -
+
+
#string To :
+The To State string.
+
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+
+
+
+
+-
+
+
+TASK_CARGO_TRANSPORT:OnBeforeCargoDeployed(From, Event, To, TaskUnit, Cargo, DeployZone)
+
+
+-
+
+
OnBefore Transition Handler for Event CargoDeployed.
+
+ Parameters
+
+ -
+
+
#string From :
+The From State string.
+
+
+ -
+
+
#string Event :
+The Event string.
+
+
+ -
+
+
#string To :
+The To State string.
+
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that Deployed the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+ -
+
+
Core.Zone#ZONE DeployZone :
+The zone where the Cargo got Deployed or UnBoarded.
+
+
+
+ Return value
+
+#boolean:
+Return false to cancel Transition.
+
+
+
+
+-
+
+
+TASK_CARGO_TRANSPORT:OnBeforeCargoPickedUp(From, Event, To, TaskUnit, Cargo)
+
+
+-
+
+
OnBefore Transition Handler for Event CargoPickedUp.
+
+ Parameters
+
+ -
+
+
#string From :
+The From State string.
+
+
+ -
+
+
#string Event :
+The Event string.
+
+
+ -
+
+
#string To :
+The To State string.
+
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+
+ Return value
+
+#boolean:
+Return false to cancel Transition.
+
+
+
+
+-
+
+
+TASK_CARGO_TRANSPORT:__CargoDeployed(Delay, TaskUnit, Cargo, DeployZone)
+
+
+-
+
+
Asynchronous Event Trigger for Event CargoDeployed.
+
+ Parameters
+
+ -
+
+
#number Delay :
+The delay in seconds.
+
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that Deployed the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+ -
+
+
Core.Zone#ZONE DeployZone :
+The zone where the Cargo got Deployed or UnBoarded.
+
+
+
+
+
+
+-
+
+
+TASK_CARGO_TRANSPORT:__CargoPickedUp(Delay, TaskUnit, Cargo)
+
+
+-
+
+
Asynchronous Event Trigger for Event CargoPickedUp.
+
+ Parameters
+
+ -
+
+
#number Delay :
+The delay in seconds.
+
+
+ -
+
+
Wrapper.Unit#UNIT TaskUnit :
+The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
+
+
+ -
+
+
Core.Cargo#CARGO Cargo :
+The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
+
+
+
diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html
index 3a8412d01..62f018d83 100644
--- a/docs/Documentation/Task_PICKUP.html
+++ b/docs/Documentation/Task_PICKUP.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html
index 3ab810188..9c4cba55e 100644
--- a/docs/Documentation/Unit.html
+++ b/docs/Documentation/Unit.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html
index 406805680..466bf943c 100644
--- a/docs/Documentation/Utils.html
+++ b/docs/Documentation/Utils.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html
index b9f59126b..d29a1c796 100644
--- a/docs/Documentation/Zone.html
+++ b/docs/Documentation/Zone.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html
index d5bc129b9..cb57d1c5c 100644
--- a/docs/Documentation/env.html
+++ b/docs/Documentation/env.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html
index 5487299fe..5766ea5a2 100644
--- a/docs/Documentation/index.html
+++ b/docs/Documentation/index.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
@@ -95,6 +96,18 @@
Module
+
+ | AI_BAI |
+
+ AI -- Provide Battleground Air Interdiction (bombing).
+
+
+
+
+
+AI_BAI classes makes AI Controllables execute bombing tasks.
+ |
+
| AI_Balancer |
diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html
index 2eb402711..9d747a907 100644
--- a/docs/Documentation/land.html
+++ b/docs/Documentation/land.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html
index d1720c599..e497edb3a 100644
--- a/docs/Documentation/routines.html
+++ b/docs/Documentation/routines.html
@@ -17,6 +17,7 @@
index
+ - AI_BAI
- AI_Balancer
- AI_Cap
- AI_Cas
diff --git a/docs/Presentations/AI_BAI/Dia1.JPG b/docs/Presentations/AI_BAI/Dia1.JPG
new file mode 100644
index 000000000..0e9aee274
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia1.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia10.JPG b/docs/Presentations/AI_BAI/Dia10.JPG
new file mode 100644
index 000000000..f05ed47f0
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia10.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia11.JPG b/docs/Presentations/AI_BAI/Dia11.JPG
new file mode 100644
index 000000000..93a3022fc
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia11.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia12.JPG b/docs/Presentations/AI_BAI/Dia12.JPG
new file mode 100644
index 000000000..06e16117f
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia12.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia13.JPG b/docs/Presentations/AI_BAI/Dia13.JPG
new file mode 100644
index 000000000..6cf4597db
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia13.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia2.JPG b/docs/Presentations/AI_BAI/Dia2.JPG
new file mode 100644
index 000000000..56c7c7f69
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia2.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia3.JPG b/docs/Presentations/AI_BAI/Dia3.JPG
new file mode 100644
index 000000000..649005caa
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia3.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia4.JPG b/docs/Presentations/AI_BAI/Dia4.JPG
new file mode 100644
index 000000000..e5f8119bf
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia4.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia5.JPG b/docs/Presentations/AI_BAI/Dia5.JPG
new file mode 100644
index 000000000..22f923f5c
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia5.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia6.JPG b/docs/Presentations/AI_BAI/Dia6.JPG
new file mode 100644
index 000000000..668413e95
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia6.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia7.JPG b/docs/Presentations/AI_BAI/Dia7.JPG
new file mode 100644
index 000000000..9dbd086c3
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia7.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia8.JPG b/docs/Presentations/AI_BAI/Dia8.JPG
new file mode 100644
index 000000000..b4c0aec03
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia8.JPG differ
diff --git a/docs/Presentations/AI_BAI/Dia9.JPG b/docs/Presentations/AI_BAI/Dia9.JPG
new file mode 100644
index 000000000..a2038d909
Binary files /dev/null and b/docs/Presentations/AI_BAI/Dia9.JPG differ
|