Module Tasking.Tasking.Task_A2A
Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Author: FlightControl
Contributions:
Global(s)
Global TASK_A2A |
Defines Air To Air tasks for a Set of Target Units, based on the tasking capabilities defined in Tasking.Task#TASK. |
Defines Air To Air tasks for a Set of Target Units, based on the tasking capabilities defined in Tasking.Task#TASK.
The TASK_A2A is implemented using a Core.Fsm#FSM_TASK, and has the following statuses:
- None: Start of the process
- Planned: The A2A task is planned.
- Assigned: The A2A task is assigned to a Wrapper.Group#GROUP.
- Success: The A2A task is successfully completed.
- Failed: The A2A task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.
1) Set the scoring of achievements in an A2A attack.
Scoring or penalties can be given in the following circumstances:
- TASK_A2A.SetScoreOnDestroy(): Set a score when a target in scope of the A2A attack, has been destroyed.
- TASK_A2A.SetScoreOnSuccess(): Set a score when all the targets in scope of the A2A attack, have been destroyed.
- TASK_A2A.SetPenaltyOnFailed(): Set a penalty when the A2A attack has failed.
Global TASK_A2A_ENGAGE |
Defines an engage task for a human player to be executed. |
Defines an engage task for a human player to be executed.
When enemy planes are close to human players, use this task type is used urge the players to get out there!
The TASKA2AENGAGE is used by the Tasking.Task_A2A_Dispatcher#TASK_A2A_DISPATCHER to automatically create engage tasks based on detected airborne enemy targets intruding friendly airspace.
The task is defined for a Tasking.Mission#MISSION, where a friendly Core.Set#SET_GROUP consisting of GROUPs with one human players each, is engaging the targets. The task is given a name and a briefing, that is used in the menu structure and in the reporting.
Global TASK_A2A_INTERCEPT |
Defines an intercept task for a human player to be executed. |
Defines an intercept task for a human player to be executed.
When enemy planes need to be intercepted by human players, use this task type to urgen the players to get out there!
The TASKA2AINTERCEPT is used by the Tasking.Task_A2A_Dispatcher#TASK_A2A_DISPATCHER to automatically create intercept tasks based on detected airborne enemy targets intruding friendly airspace.
The task is defined for a Tasking.Mission#MISSION, where a friendly Core.Set#SET_GROUP consisting of GROUPs with one human players each, is intercepting the targets. The task is given a name and a briefing, that is used in the menu structure and in the reporting.
Global TASK_A2A_SWEEP |
Defines a sweep task for a human player to be executed. |
Defines a sweep task for a human player to be executed.
A sweep task needs to be given when targets were detected but somehow the detection was lost. Most likely, these enemy planes are hidden in the mountains or are flying under radar. These enemy planes need to be sweeped by human players, and use this task type to urge the players to get out there and find those enemy fighters.
The TASKA2ASWEEP is used by the Tasking.Task_A2A_Dispatcher#TASK_A2A_DISPATCHER to automatically create sweep tasks based on detected airborne enemy targets intruding friendly airspace, for which the detection has been lost for more than 60 seconds.
The task is defined for a Tasking.Mission#MISSION, where a friendly Core.Set#SET_GROUP consisting of GROUPs with one human players each, is sweeping the targets. The task is given a name and a briefing, that is used in the menu structure and in the reporting.
Type(s)
Extends Tasking.Task#TASK
The TASK_A2A class
Field(s)
Function(s)
Parameter:
Return values:
The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
Parameter:
Return value:
The Zone object where the RendezVous is located on the map.
Parameter:
Return value:
The Coordinate object where the Target is located on the map.
Parameter:
Return value:
The Zone object where the Target is located on the map.
Instantiates a new TASK_A2A.
Parameters:
The set of groups for which the Task can be assigned.
The name of the Task.
The distance to Target when the Player is considered to have "arrived" at the engagement range.
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.
Return value:
self
Return the relative distance to the target vicinity from the player, in order to sort the targets in the reports per distance from the threats.
Parameter:
Parameters:
The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
Parameters:
The Zone object where the RendezVous is located on the map.
Parameters:
The Coordinate object where the Target is located on the map.
Parameters:
The Zone object where the Target is located on the map.
Parameter:
This method checks every 10 seconds if the goal has been reached of the task.
Parameters:
Extends Tasking.Task#TASK
The TASKA2AENGAGE class
Function(s)
Instantiates a new TASKA2AENGAGE.
Parameters:
The set of groups for which the Task can be assigned.
The name of the Task.
The briefing of the task.
Return value:
self
Set a penalty when the A2A attack has failed.
Parameters:
The name of the player.
The penalty in points, must be a negative value!
Return value:
Set a score when a target in scope of the A2A attack, has been destroyed .
Parameters:
The name of the player.
The score in points to be granted when task process has been achieved.
Return value:
Set a score when all the targets in scope of the A2A attack, have been destroyed.
Parameters:
The name of the player.
The score in points.
Return value:
Extends Tasking.Task#TASK
The TASKA2AINTERCEPT class
Function(s)
Instantiates a new TASKA2AINTERCEPT.
Parameters:
The set of groups for which the Task can be assigned.
The name of the Task.
The briefing of the task.
Return value:
Set a penalty when the A2A attack has failed.
Parameters:
The name of the player.
The penalty in points, must be a negative value!
Return value:
Set a score when a target in scope of the A2A attack, has been destroyed .
Parameters:
The name of the player.
The score in points to be granted when task process has been achieved.
Return value:
Set a score when all the targets in scope of the A2A attack, have been destroyed.
Parameters:
The name of the player.
The score in points.
Return value:
Extends Tasking.Task#TASK
The TASKA2ASWEEP class
Function(s)
Instantiates a new TASKA2ASWEEP.
Parameters:
The set of groups for which the Task can be assigned.
The name of the Task.
The briefing of the task.
Return value:
self
Set a penalty when the A2A attack has failed.
Parameters:
The name of the player.
The penalty in points, must be a negative value!
Return value:
Set a score when a target in scope of the A2A attack, has been destroyed .
Parameters:
The name of the player.
The score in points to be granted when task process has been achieved.
Return value:
Set a score when all the targets in scope of the A2A attack, have been destroyed.
Parameters:
The name of the player.
The score in points.