From 1b36cee3b65d63b86927e9ae535e4921826ad166 Mon Sep 17 00:00:00 2001 From: FlightControl Date: Sat, 24 Jun 2017 16:21:43 +0200 Subject: [PATCH] Documentation --- docs/Documentation/Account.html | 154 ++++- docs/Documentation/Cargo.html | 1 + docs/Documentation/Designate.html | 1 - docs/Documentation/Detection.html | 2 + docs/Documentation/Fsm.html | 27 - docs/Documentation/Movement.html | 4 + docs/Documentation/Point.html | 1 - docs/Documentation/Spawn.html | 30 +- docs/Documentation/Task.html | 336 ++++++++++ docs/Documentation/Task_A2A.html | 658 ++++++++++++++++---- docs/Documentation/Task_A2A_Dispatcher.html | 39 ++ docs/Documentation/Task_A2G.html | 654 +++++++++++++++---- docs/Documentation/Task_Cargo.html | 15 +- 13 files changed, 1582 insertions(+), 340 deletions(-) diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html index ba1a8bfcb..30897586d 100644 --- a/docs/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -223,6 +223,18 @@ ACT_ACCOUNT_DEADS:New(TargetSetUnit, TaskName)

Creates a new DESTROY process.

+ + + + ACT_ACCOUNT_DEADS:OnEventHit(EventData) + + + + + + ACT_ACCOUNT_DEADS.PlayerHits + + @@ -238,13 +250,19 @@ - ACT_ACCOUNT_DEADS:onafterEvent(ProcessUnit, Event, From, To, Task) + ACT_ACCOUNT_DEADS:onafterEvent(ProcessClient, Task, From, Event, To, EventData)

StateMachine callback function

- ACT_ACCOUNT_DEADS:onenterAccount(ProcessUnit, Event, From, To, Task, EventData) + ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessClient, Task, From, Event, To, EventData) + +

StateMachine callback function

+ + + + ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessClient, Task, From, Event, To, EventData)

StateMachine callback function

@@ -253,6 +271,12 @@ ACT_ACCOUNT_DEADS:onenterReport(ProcessUnit, Event, From, To, Task)

StateMachine callback function

+ + + + ACT_ACCOUNT_DEADS:onfuncEventCrash(EventData) + + @@ -674,6 +698,40 @@ Each successful dead will trigger an Account state transition that can be scored + + +
+
+ + +ACT_ACCOUNT_DEADS:OnEventHit(EventData) + +
+
+ + + +

Parameter

+ +
+
+
+
+ + +ACT_ACCOUNT_DEADS.PlayerHits + +
+
+ + +
@@ -708,7 +766,7 @@ Each successful dead will trigger an Account state transition that can be scored
-ACT_ACCOUNT_DEADS:onafterEvent(ProcessUnit, Event, From, To, Task) +ACT_ACCOUNT_DEADS:onafterEvent(ProcessClient, Task, From, Event, To, EventData)
@@ -719,12 +777,12 @@ Each successful dead will trigger an Account state transition that can be scored @@ -748,8 +811,8 @@ Each successful dead will trigger an Account state transition that can be scored
- -ACT_ACCOUNT_DEADS:onenterAccount(ProcessUnit, Event, From, To, Task, EventData) + +ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessClient, Task, From, Event, To, EventData)
@@ -760,12 +823,12 @@ Each successful dead will trigger an Account state transition that can be scored +
+
+
+
+ + +ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessClient, Task, From, Event, To, EventData) + +
+
+ +

StateMachine callback function

+ +

Parameters

+ @@ -835,6 +944,27 @@ Each successful dead will trigger an Account state transition that can be scored
+ +ACT_ACCOUNT_DEADS:onfuncEventCrash(EventData) + +
+
+ + + +

Parameter

+ +
+
+
+
+ ACT_ACCOUNT_DEADS:onfuncEventDead(EventData) diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 262969991..d774a472f 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -3059,6 +3059,7 @@ The range till cargo will board.

+ #number CARGO_UNIT.RunCount diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index 70e3562df..c0c7ee573 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -900,7 +900,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 1754d0aa0..141b7d951 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2393,6 +2393,7 @@ The index of the DetectedItem.

+ #number DETECTION_BASE.DetectedItemCount @@ -2406,6 +2407,7 @@ The index of the DetectedItem.

+ #number DETECTION_BASE.DetectedItemMax diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 401b60084..e0276d335 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -633,12 +633,6 @@ Additionally, I've added extendability and created an API that allows seamless F FSM_PROCESS:onenterFailed(ProcessUnit) - - - - FSM_PROCESS:onenterSuccess(ProcessUnit) - - @@ -2619,27 +2613,6 @@ self

-

Parameter

-
    -
  • - -

    ProcessUnit :

    - -
    • -
-
-
-
-
- - -FSM_PROCESS:onenterSuccess(ProcessUnit) - -
-
- - -

Parameter

  • diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 4307c3aaa..be5ce073c 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -227,6 +227,7 @@ on defined intervals (currently every minute).

    + #number MOVEMENT.AliveUnits @@ -235,6 +236,9 @@ on defined intervals (currently every minute).

    + +

    Contains the counter how many units are currently alive

    +
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index 74e7fcb9a..f204d56d9 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -2799,7 +2799,6 @@ The y coordinate.

- POINT_VEC2.z diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 84f7c4122..6161409ef 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -822,12 +822,6 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) - - - - SPAWN.uncontrolled - - @@ -2200,9 +2194,6 @@ The group that was spawned. You can use this group for further actions.

- -

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

-
@@ -2735,6 +2726,9 @@ when nothing was spawned.

+ +

Overwrite unit names by default with group name.

+
@@ -3129,7 +3123,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- #boolean + SPAWN.SpawnUnControlled @@ -3153,7 +3147,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

When the first Spawn executes, all the Groups need to be made visible before start.

+

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

@@ -3733,20 +3727,6 @@ True = Continue Scheduler

- -
-
-
- - - -SPAWN.uncontrolled - -
-
- - -
diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index 910dec688..1cf449b57 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -141,6 +141,12 @@ TASK:AbortGroup(PlayerUnit, PlayerGroup)

Abort a PlayerUnit from a Task.

+ + + + TASK:AddProgress(PlayerName, ProgressText, ProgressTime, ProgressPoints) + +

Add Task Progress for a Player Name

@@ -297,6 +303,12 @@ TASK:GetUnitProcess(TaskUnit)

Get the Task FSM Process Template

+ + + + TASK:Goal() + +

Goal Trigger for TASK

@@ -411,6 +423,12 @@ TASK:New(Mission, SetGroupAssign, TaskName, TaskType, TaskBriefing)

Instantiates a new TASK.

+ + + + TASK:OnAfterGoal(Controllable, From, Event, To) + +

Goal Handler OnAfter for TASK

@@ -429,6 +447,12 @@ TASK:OnAfterPlayerDead(PlayerUnit, PlayerName)

FSM PlayerDead event handler prototype for TASK.

+ + + + TASK:OnBeforeGoal(Controllable, From, Event, To) + +

Goal Handler OnBefore for TASK

@@ -549,6 +573,24 @@ TASK:SetPlannedMenuForGroup(TaskGroup, MenuText, MenuTime)

Set the planned menu option of the Task.

+ + + + TASK:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +

Set a penalty when the A2A attack has failed.

+ + + + TASK:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +

Set a score when progress has been made by the player.

+ + + + TASK:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

@@ -645,6 +687,12 @@ TASK.TaskName + + + + TASK.TaskProgress + + @@ -699,6 +747,12 @@ TASK:__Fail()

FSM Fail asynchronous event function for TASK.

+ + + + TASK:__Goal(Delay) + +

Goal Asynchronous Trigger for TASK

@@ -883,6 +937,50 @@ The CLIENT or UNIT of the Player aborting the Task.

#TASK:

+ + +
+
+ + +TASK:AddProgress(PlayerName, ProgressText, ProgressTime, ProgressPoints) + +
+
+ +

Add Task Progress for a Player Name

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #string ProgressText : +The text that explains the Progress achieved.

    + +
    • +
  • + +

    #number ProgressTime : +The time the progress was achieved.

    + +
    • +
  • + +

    ProgressPoints :

    + +
    • +
+

Return value

+ +

#TASK:

+ +
@@ -1407,6 +1505,19 @@ TaskType

Core.Fsm#FSM_PROCESS:

+ +
+
+
+ + +TASK:Goal() + +
+
+ +

Goal Trigger for TASK

+
@@ -1801,6 +1912,42 @@ self

+ +TASK:OnAfterGoal(Controllable, From, Event, To) + +
+
+ +

Goal Handler OnAfter for TASK

+ +

Parameters

+ +
+
+
+
+ TASK:OnAfterPlayerAborted(PlayerUnit, PlayerName) @@ -1885,6 +2032,47 @@ The name of the Player.

+ +TASK:OnBeforeGoal(Controllable, From, Event, To) + +
+
+ +

Goal Handler OnBefore for TASK

+ +

Parameters

+ +

Return value

+ +

#boolean:

+ + +
+
+
+
+ TASK:RefreshMenus(TaskGroup, MenuTime) @@ -2392,6 +2580,120 @@ The menu text.

#TASK: self

+ +
+
+
+ + +TASK:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +
+
+ +

Set a penalty when the A2A attack has failed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Penalty : +The penalty in points, must be a negative value!

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASK:

+ + +
+
+
+
+ + +TASK:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when progress has been made by the player.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points to be granted when task process has been achieved.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASK:

+ + +
+
+
+
+ + +TASK:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASK:

+ +
@@ -2663,6 +2965,19 @@ Fsm#FSM_PROCESS

+ +
+
+
+ + +TASK.TaskProgress + +
+
+ + +
@@ -2818,6 +3133,27 @@ self

+ +TASK:__Goal(Delay) + +
+
+ +

Goal Asynchronous Trigger for TASK

+ +

Parameter

+
    +
  • + +

    #number Delay :

    + +
    • +
+
+
+
+
+ TASK:__Replan() diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html index c5b62bf8b..584ef585f 100644 --- a/docs/Documentation/Task_A2A.html +++ b/docs/Documentation/Task_A2A.html @@ -192,12 +192,6 @@ based on the tasking capabilities defined in Task#TA TASK_A2A:New(Mission, SetAttack, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing)

Instantiates a new TASK_A2A.

- - - - TASK_A2A:SetPenaltyOnFailed(Text, Penalty, TaskUnit) - -

Set a penalty when the A2A attack has failed.

@@ -210,18 +204,6 @@ based on the tasking capabilities defined in Task#TA TASK_A2A:SetRendezVousZone(RendezVousZone, TaskUnit) - - - - TASK_A2A:SetScoreOnDestroy(Text, Score, TaskUnit) - -

Set a score when a target in scope of the A2A attack, has been destroyed .

- - - - TASK_A2A:SetScoreOnSuccess(Text, Score, TaskUnit) - -

Set a score when all the targets in scope of the A2A attack, have been destroyed.

@@ -250,12 +232,36 @@ based on the tasking capabilities defined in Task#TA TASK_A2A_ENGAGE:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)

Instantiates a new TASKA2AENGAGE.

+ + + + TASK_A2A_ENGAGE:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +

Set a penalty when the A2A attack has failed.

+ + + + TASK_A2A_ENGAGE:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ + + + TASK_A2A_ENGAGE:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

TASK_A2A_ENGAGE.TargetSetUnit + + + + TASK_A2A_ENGAGE:onafterGoal(TaskUnit, From, Event, To) + + @@ -266,12 +272,36 @@ based on the tasking capabilities defined in Task#TA TASK_A2A_INTERCEPT:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)

Instantiates a new TASKA2AINTERCEPT.

+ + + + TASK_A2A_INTERCEPT:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +

Set a penalty when the A2A attack has failed.

+ + + + TASK_A2A_INTERCEPT:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ + + + TASK_A2A_INTERCEPT:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

TASK_A2A_INTERCEPT.TargetSetUnit + + + + TASK_A2A_INTERCEPT:onafterGoal(TaskUnit, From, Event, To) + + @@ -282,12 +312,36 @@ based on the tasking capabilities defined in Task#TA TASK_A2A_SWEEP:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)

Instantiates a new TASKA2ASWEEP.

+ + + + TASK_A2A_SWEEP:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +

Set a penalty when the A2A attack has failed.

+ + + + TASK_A2A_SWEEP:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ + + + TASK_A2A_SWEEP:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

TASK_A2A_SWEEP.TargetSetUnit + + + + TASK_A2A_SWEEP:onafterGoal(TaskUnit, From, Event, To) + + @@ -617,44 +671,6 @@ If the TargetZone parameter is specified, the player will be routed to the cente

#TASK_A2A: self

- -
-
-
- - -TASK_A2A:SetPenaltyOnFailed(Text, Penalty, TaskUnit) - -
-
- -

Set a penalty when the A2A attack has failed.

- -

Parameters

-
    -
  • - -

    #string Text : -The text to display to the player, when the A2A attack has failed.

    - -
    • -
  • - -

    #number Penalty : -The penalty in points.

    - -
    • -
  • - -

    Wrapper.Unit#UNIT TaskUnit :

    - -
    • -
-

Return value

- -

#TASK_A2A:

- -
@@ -720,82 +736,6 @@ The Zone object where the RendezVous is located on the map.

- -TASK_A2A:SetScoreOnDestroy(Text, Score, TaskUnit) - -
-
- -

Set a score when a target in scope of the A2A attack, has been destroyed .

- -

Parameters

-
    -
  • - -

    #string Text : -The text to display to the player, when the target has been destroyed.

    - -
    • -
  • - -

    #number Score : -The score in points.

    - -
    • -
  • - -

    Wrapper.Unit#UNIT TaskUnit :

    - -
    • -
-

Return value

- -

#TASK_A2A:

- - -
-
-
-
- - -TASK_A2A:SetScoreOnSuccess(Text, Score, TaskUnit) - -
-
- -

Set a score when all the targets in scope of the A2A attack, have been destroyed.

- -

Parameters

-
    -
  • - -

    #string Text : -The text to display to the player, when all targets hav been destroyed.

    - -
    • -
  • - -

    #number Score : -The score in points.

    - -
    • -
  • - -

    Wrapper.Unit#UNIT TaskUnit :

    - -
    • -
-

Return value

- -

#TASK_A2A:

- - -
-
-
-
- TASK_A2A:SetTargetCoordinate(TargetCoordinate, TaskUnit) @@ -924,6 +864,120 @@ The briefing of the task.

#TASKA2AENGAGE: self

+ +
+
+
+ + +TASK_A2A_ENGAGE:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +
+
+ +

Set a penalty when the A2A attack has failed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Penalty : +The penalty in points, must be a negative value!

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2AENGAGE:

+ + +
+
+
+
+ + +TASK_A2A_ENGAGE:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points to be granted when task process has been achieved.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2AENGAGE:

+ + +
+
+
+
+ + +TASK_A2A_ENGAGE:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2AENGAGE:

+ +
@@ -938,6 +992,42 @@ self

+ +
+
+
+ + +TASK_A2A_ENGAGE:onafterGoal(TaskUnit, From, Event, To) + +
+
+ + + +

Parameters

+
    +
  • + +

    TaskUnit :

    + +
    • +
  • + +

    From :

    + +
    • +
  • + +

    Event :

    + +
    • +
  • + +

    To :

    + +
    • +
@@ -990,8 +1080,122 @@ The briefing of the task.

Return value

-

#TASKA2AINTERCEPT: -self

+

#TASKA2AINTERCEPT:

+ + + +
+
+
+ + +TASK_A2A_INTERCEPT:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +
+
+ +

Set a penalty when the A2A attack has failed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Penalty : +The penalty in points, must be a negative value!

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2AINTERCEPT:

+ + +
+
+
+
+ + +TASK_A2A_INTERCEPT:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points to be granted when task process has been achieved.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2AINTERCEPT:

+ + +
+
+
+
+ + +TASK_A2A_INTERCEPT:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2AINTERCEPT:

+
@@ -1007,6 +1211,42 @@ self

+ +
+
+
+ + +TASK_A2A_INTERCEPT:onafterGoal(TaskUnit, From, Event, To) + +
+
+ + + +

Parameters

+
    +
  • + +

    TaskUnit :

    + +
    • +
  • + +

    From :

    + +
    • +
  • + +

    Event :

    + +
    • +
  • + +

    To :

    + +
    • +
@@ -1062,6 +1302,120 @@ The briefing of the task.

#TASKA2ASWEEP: self

+ +
+
+
+ + +TASK_A2A_SWEEP:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +
+
+ +

Set a penalty when the A2A attack has failed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Penalty : +The penalty in points, must be a negative value!

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2ASWEEP:

+ + +
+
+
+
+ + +TASK_A2A_SWEEP:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points to be granted when task process has been achieved.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2ASWEEP:

+ + +
+
+
+
+ + +TASK_A2A_SWEEP:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2ASWEEP:

+ +
@@ -1076,6 +1430,42 @@ self

+ +
+
+
+ + +TASK_A2A_SWEEP:onafterGoal(TaskUnit, From, Event, To) + +
+
+ + + +

Parameters

+
    +
  • + +

    TaskUnit :

    + +
    • +
  • + +

    From :

    + +
    • +
  • + +

    Event :

    + +
    • +
  • + +

    To :

    + +
    • +
diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html index 285239f44..e9ee5a1da 100644 --- a/docs/Documentation/Task_A2A_Dispatcher.html +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -340,6 +340,45 @@ You need to evaluate the value of this parameter carefully. If too small, more intercept missions may be triggered upon detected target areas. If too large, any airborne cap may not be able to reach the detected target area in time, because it is too far.

+

4. Set Scoring and Messages:

+ +

The TASK_A2A_DISPATCHER is a state machine. It triggers the event Assign when a new player joins a Task dispatched by the TASK_A2A_DISPATCHER. +An event handler can be defined to catch the Assign event, and add additional processing to set scoring and to define messages, +when the player reaches certain achievements in the task.

+ +

The prototype to handle the Assign event needs to be developed as follows:

+ +
 TaskDispatcher = TASK_A2A_DISPATCHER:New( ... )
+
+ --- @param #TaskDispatcher self
+ -- @param #string From Contains the name of the state from where the Event was triggered.
+ -- @param #string Event Contains the name of the event that was triggered. In this case Assign.
+ -- @param #string To Contains the name of the state that will be transitioned to.
+ -- @param Tasking.Task_A2A#TASK_A2A Task The Task object, which is any derived object from TASK_A2A.
+ -- @param Wrapper.Unit#UNIT TaskUnit The Unit or Client that contains the Player.
+ -- @param #string PlayerName The name of the Player that joined the TaskUnit.
+ function TaskDispatcher:OnAfterAssign( From, Event, To, Task, TaskUnit, PlayerName )
+   Task:SetScoreOnProgress( PlayerName, 20, TaskUnit )
+   Task:SetScoreOnSuccess( PlayerName, 200, TaskUnit )
+   Task:SetScoreOnFail( PlayerName, -100, TaskUnit )
+ end
+
+ +

The OnAfterAssign method (function) is added to the TaskDispatcher object. +This method will be called when a new player joins a unit in the set of groups in scope of the dispatcher. +So, this method will be called only ONCE when a player joins a unit in scope of the task.

+ +

The TASK class implements various methods to additional set scoring for player achievements:

+ + +
diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html index 58b90c4d6..6b55b2294 100644 --- a/docs/Documentation/Task_A2G.html +++ b/docs/Documentation/Task_A2G.html @@ -192,12 +192,6 @@ based on the tasking capabilities defined in Task#TA TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing)

Instantiates a new TASK_A2G.

- - - - TASK_A2G:SetPenaltyOnFailed(Text, Penalty, TaskUnit) - -

Set a penalty when the A2G attack has failed.

@@ -210,18 +204,6 @@ based on the tasking capabilities defined in Task#TA TASK_A2G:SetRendezVousZone(RendezVousZone, TaskUnit) - - - - TASK_A2G:SetScoreOnDestroy(Text, Score, TaskUnit) - -

Set a score when a target in scope of the A2G attack, has been destroyed .

- - - - TASK_A2G:SetScoreOnSuccess(Text, Score, TaskUnit) - -

Set a score when all the targets in scope of the A2G attack, have been destroyed.

@@ -250,12 +232,36 @@ based on the tasking capabilities defined in Task#TA TASK_A2G_BAI:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)

Instantiates a new TASKA2GBAI.

+ + + + TASK_A2G_BAI:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +

Set a penalty when the A2A attack has failed.

+ + + + TASK_A2G_BAI:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ + + + TASK_A2G_BAI:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

TASK_A2G_BAI.TargetSetUnit + + + + TASK_A2G_BAI:onafterGoal(TaskUnit, From, Event, To) + + @@ -266,12 +272,36 @@ based on the tasking capabilities defined in Task#TA TASK_A2G_CAS:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)

Instantiates a new TASKA2GCAS.

+ + + + TASK_A2G_CAS:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +

Set a penalty when the A2A attack has failed.

+ + + + TASK_A2G_CAS:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ + + + TASK_A2G_CAS:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

TASK_A2G_CAS.TargetSetUnit + + + + TASK_A2G_CAS:onafterGoal(TaskUnit, From, Event, To) + + @@ -282,12 +312,36 @@ based on the tasking capabilities defined in Task#TA TASK_A2G_SEAD:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)

Instantiates a new TASKA2GSEAD.

+ + + + TASK_A2G_SEAD:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +

Set a penalty when the A2A attack has failed.

+ + + + TASK_A2G_SEAD:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ + + + TASK_A2G_SEAD:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

TASK_A2G_SEAD.TargetSetUnit + + + + TASK_A2G_SEAD:onafterGoal(TaskUnit, From, Event, To) + + @@ -607,44 +661,6 @@ If the TargetZone parameter is specified, the player will be routed to the cente

#TASK_A2G: self

- - -
-
- - -TASK_A2G:SetPenaltyOnFailed(Text, Penalty, TaskUnit) - -
-
- -

Set a penalty when the A2G attack has failed.

- -

Parameters

-
    -
  • - -

    #string Text : -The text to display to the player, when the A2G attack has failed.

    - -
    • -
  • - -

    #number Penalty : -The penalty in points.

    - -
    • -
  • - -

    Wrapper.Unit#UNIT TaskUnit :

    - -
    • -
-

Return value

- -

#TASK_A2G:

- -
@@ -710,82 +726,6 @@ The Zone object where the RendezVous is located on the map.

- -TASK_A2G:SetScoreOnDestroy(Text, Score, TaskUnit) - -
-
- -

Set a score when a target in scope of the A2G attack, has been destroyed .

- -

Parameters

-
    -
  • - -

    #string Text : -The text to display to the player, when the target has been destroyed.

    - -
    • -
  • - -

    #number Score : -The score in points.

    - -
    • -
  • - -

    Wrapper.Unit#UNIT TaskUnit :

    - -
    • -
-

Return value

- -

#TASK_A2G:

- - -
-
-
-
- - -TASK_A2G:SetScoreOnSuccess(Text, Score, TaskUnit) - -
-
- -

Set a score when all the targets in scope of the A2G attack, have been destroyed.

- -

Parameters

-
    -
  • - -

    #string Text : -The text to display to the player, when all targets hav been destroyed.

    - -
    • -
  • - -

    #number Score : -The score in points.

    - -
    • -
  • - -

    Wrapper.Unit#UNIT TaskUnit :

    - -
    • -
-

Return value

- -

#TASK_A2G:

- - -
-
-
-
- TASK_A2G:SetTargetCoordinate(TargetCoordinate, TaskUnit) @@ -904,6 +844,120 @@ The briefing of the task.

#TASKA2GBAI: self

+ +
+
+
+ + +TASK_A2G_BAI:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +
+
+ +

Set a penalty when the A2A attack has failed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Penalty : +The penalty in points, must be a negative value!

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GBAI:

+ + +
+
+
+
+ + +TASK_A2G_BAI:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points to be granted when task process has been achieved.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GBAI:

+ + +
+
+
+
+ + +TASK_A2G_BAI:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GBAI:

+ +
@@ -918,6 +972,42 @@ self

+ +
+
+
+ + +TASK_A2G_BAI:onafterGoal(TaskUnit, From, Event, To) + +
+
+ + + +

Parameters

+
    +
  • + +

    TaskUnit :

    + +
    • +
  • + +

    From :

    + +
    • +
  • + +

    Event :

    + +
    • +
  • + +

    To :

    + +
    • +
@@ -973,6 +1063,120 @@ The briefing of the task.

#TASKA2GCAS: self

+ +
+
+
+ + +TASK_A2G_CAS:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +
+
+ +

Set a penalty when the A2A attack has failed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Penalty : +The penalty in points, must be a negative value!

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GCAS:

+ + +
+
+
+
+ + +TASK_A2G_CAS:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points to be granted when task process has been achieved.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GCAS:

+ + +
+
+
+
+ + +TASK_A2G_CAS:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GCAS:

+ +
@@ -987,6 +1191,42 @@ self

+ +
+
+
+ + +TASK_A2G_CAS:onafterGoal(TaskUnit, From, Event, To) + +
+
+ + + +

Parameters

+
    +
  • + +

    TaskUnit :

    + +
    • +
  • + +

    From :

    + +
    • +
  • + +

    Event :

    + +
    • +
  • + +

    To :

    + +
    • +
@@ -1042,6 +1282,120 @@ The briefing of the task.

#TASKA2GSEAD: self

+ + +
+
+ + +TASK_A2G_SEAD:SetScoreOnFail(PlayerName, Penalty, TaskUnit) + +
+
+ +

Set a penalty when the A2A attack has failed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Penalty : +The penalty in points, must be a negative value!

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GSEAD:

+ + +
+
+
+
+ + +TASK_A2G_SEAD:SetScoreOnProgress(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when a target in scope of the A2A attack, has been destroyed .

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points to be granted when task process has been achieved.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GSEAD:

+ + +
+
+
+
+ + +TASK_A2G_SEAD:SetScoreOnSuccess(PlayerName, Score, TaskUnit) + +
+
+ +

Set a score when all the targets in scope of the A2A attack, have been destroyed.

+ +

Parameters

+
    +
  • + +

    #string PlayerName : +The name of the player.

    + +
    • +
  • + +

    #number Score : +The score in points.

    + +
    • +
  • + +

    Wrapper.Unit#UNIT TaskUnit :

    + +
    • +
+

Return value

+ +

#TASKA2GSEAD:

+ +
@@ -1056,6 +1410,42 @@ self

+ +
+
+
+ + +TASK_A2G_SEAD:onafterGoal(TaskUnit, From, Event, To) + +
+
+ + + +

Parameters

+
    +
  • + +

    TaskUnit :

    + +
    • +
  • + +

    From :

    + +
    • +
  • + +

    Event :

    + +
    • +
  • + +

    To :

    + +
    • +
diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 686daa411..8c17ced64 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -252,13 +252,13 @@ and various dedicated deployment zones.

- TASK_CARGO:SetPenaltyOnFailed(Text, Penalty, TaskUnit) + TASK_CARGO:SetScoreOnFail(Text, Penalty, TaskUnit)

Set a penalty when the A2G attack has failed.

- TASK_CARGO:SetScoreOnDestroy(Text, Score, TaskUnit) + TASK_CARGO:SetScoreOnProgress(Text, Score, TaskUnit)

Set a score when a target in scope of the A2G attack, has been destroyed .

@@ -510,7 +510,7 @@ based on the tasking capabilities defined in Task#TA
- Core.Cargo#CARGO_GROUP + FSM_PROCESS.Cargo @@ -524,7 +524,6 @@ based on the tasking capabilities defined in Task#TA
- FSM_PROCESS.DeployZone @@ -881,8 +880,8 @@ ist DeployZones

- -TASK_CARGO:SetPenaltyOnFailed(Text, Penalty, TaskUnit) + +TASK_CARGO:SetScoreOnFail(Text, Penalty, TaskUnit)
@@ -919,8 +918,8 @@ The penalty in points.

- -TASK_CARGO:SetScoreOnDestroy(Text, Score, TaskUnit) + +TASK_CARGO:SetScoreOnProgress(Text, Score, TaskUnit)