From 051cc4955f73097387f8238210fdf5d573d5ddd7 Mon Sep 17 00:00:00 2001
From: FlightControl
Date: Sat, 27 May 2017 10:09:44 +0200
Subject: [PATCH] CARGO
---
.../bin/TreeHierarchy.csv | 30 ++---
docs/Documentation/Cargo.html | 8 +-
docs/Documentation/Group.html | 24 ++++
docs/Documentation/Mission.html | 125 ++++++++++++++++++
docs/Documentation/Point.html | 117 +---------------
docs/Documentation/Radio.html | 4 +-
docs/Documentation/Spawn.html | 9 +-
docs/Documentation/Spot.html | 4 +
docs/Documentation/Task_Cargo.html | 82 +++++++++++-
9 files changed, 262 insertions(+), 141 deletions(-)
diff --git a/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv b/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv
index c5a17961d..2f09984f2 100644
--- a/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv
+++ b/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv
@@ -8,21 +8,21 @@
@K=function, @M=Task_A2G, @N=onafterEngage, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=6215,
@K=function, @M=Task_A2G, @N=onafterRouteToTarget, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=6537,
@K=function, @M=Task_A2G, @N=onafterRouteToTargets, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=7416,
-@K=function, @M=Task_Cargo, @N=onafterSelectAction, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=10673,
-@K=function, @M=Task_Cargo, @N=OnLeaveWaitingForCommand, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=13702,
-@K=function, @M=Task_Cargo, @N=onafterRouteToPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=14474,
-@K=function, @M=Task_Cargo, @N=onafterArriveAtPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15093,
-@K=function, @M=Task_Cargo, @N=onafterCancelRouteToPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15634,
-@K=function, @M=Task_Cargo, @N=onafterRouteToDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15971,
-@K=function, @M=Task_Cargo, @N=onafterArriveAtDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16418,
-@K=function, @M=Task_Cargo, @N=onafterCancelRouteToDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16846,
-@K=function, @M=Task_Cargo, @N=onafterLanded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=18133,
-@K=function, @M=Task_Cargo, @N=onafterPrepareBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=18899,
-@K=function, @M=Task_Cargo, @N=onafterBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=19359,
-@K=function, @M=Task_Cargo, @N=onafterBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=20300,
-@K=function, @M=Task_Cargo, @N=onafterPrepareUnBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=20983,
-@K=function, @M=Task_Cargo, @N=onafterUnBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=21943,
-@K=function, @M=Task_Cargo, @N=onafterUnBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=22962,
+@K=function, @M=Task_Cargo, @N=onafterSelectAction, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=10711,
+@K=function, @M=Task_Cargo, @N=OnLeaveWaitingForCommand, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=13740,
+@K=function, @M=Task_Cargo, @N=onafterRouteToPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=14601,
+@K=function, @M=Task_Cargo, @N=onafterArriveAtPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15222,
+@K=function, @M=Task_Cargo, @N=onafterCancelRouteToPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15751,
+@K=function, @M=Task_Cargo, @N=onafterRouteToDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16088,
+@K=function, @M=Task_Cargo, @N=onafterArriveAtDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16535,
+@K=function, @M=Task_Cargo, @N=onafterCancelRouteToDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16963,
+@K=function, @M=Task_Cargo, @N=onafterLanded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=18250,
+@K=function, @M=Task_Cargo, @N=onafterPrepareBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=19016,
+@K=function, @M=Task_Cargo, @N=onafterBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=19476,
+@K=function, @M=Task_Cargo, @N=onafterBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=20417,
+@K=function, @M=Task_Cargo, @N=onafterPrepareUnBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=21100,
+@K=function, @M=Task_Cargo, @N=onafterUnBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=22060,
+@K=function, @M=Task_Cargo, @N=onafterUnBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=23079,
@K=function, @M=Designate, @N=OnBeforeLaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12218,
@K=function, @M=Designate, @N=OnAfterLaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12466,
@K=function, @M=Designate, @N=LaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12687,
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html
index 875f99a43..243a8f68c 100644
--- a/docs/Documentation/Cargo.html
+++ b/docs/Documentation/Cargo.html
@@ -119,9 +119,9 @@
Demo Missions
-
+
-
+
@@ -129,7 +129,7 @@
YouTube Channel
-
+
@@ -2924,6 +2924,7 @@ The range till cargo will board.
-
+
CARGO_UNIT.CargoCarrier
@@ -3049,7 +3050,6 @@ The range till cargo will board.
-
- #number
CARGO_UNIT.RunCount
diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html
index 13a3699cd..5cfa7fc71 100644
--- a/docs/Documentation/Group.html
+++ b/docs/Documentation/Group.html
@@ -305,6 +305,12 @@
| GROUP:GetMinHeight() |
Returns the current minimum height of the group.
+ |
+
+
+ | GROUP:GetPlayerName() |
+
+ Gets the player name of the group.
|
@@ -1103,6 +1109,24 @@ Minimum height found.
-
+
+GROUP:GetPlayerName()
+
+
+-
+
+
Gets the player name of the group.
+
+ Return value
+
+#string:
+The player name of the group.
+
+
+
+
+-
+
GROUP:GetPlayerNames()
diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html
index 127fc4288..6d500b748 100644
--- a/docs/Documentation/Mission.html
+++ b/docs/Documentation/Mission.html
@@ -301,6 +301,12 @@ A CLIENT needs to be registered within the MISSION.MissionBriefing
|
+ |
+
+
+ | MISSION:MissionGoals() |
+
+ MissionGoals Trigger for MISSION
|
@@ -337,6 +343,12 @@ A CLIENT needs to be registered within the MISSION:OnAfterFail(From, Event, To)
|
OnAfter Transition Handler for Event Fail.
+ |
+
+
+ | MISSION:OnAfterMissionGoals(From, Event, To) |
+
+ MissionGoals Handler OnAfter for MISSION
|
@@ -361,6 +373,12 @@ A CLIENT needs to be registered within the MISSION:OnBeforeFail(From, Event, To)
|
OnBefore Transition Handler for Event Fail.
+ |
+
+
+ | MISSION:OnBeforeMissionGoals(From, Event, To) |
+
+ MissionGoals Handler OnBefore for MISSION
|
@@ -523,6 +541,12 @@ A CLIENT needs to be registered within the MISSION:__Fail(Delay)
|
Asynchronous Event Trigger for Event Fail.
+ |
+
+
+ | MISSION:__MissionGoals(Delay) |
+
+ MissionGoals Asynchronous Trigger for MISSION
|
@@ -1272,6 +1296,19 @@ The status
+
+
+
+-
+
+
+MISSION:MissionGoals()
+
+
+-
+
+
MissionGoals Trigger for MISSION
+
@@ -1440,6 +1477,37 @@ The To State string.
-
+
+MISSION:OnAfterMissionGoals(From, Event, To)
+
+
+-
+
+
MissionGoals Handler OnAfter for MISSION
+
+ Parameters
+
+ -
+
+
#string From :
+
+
+ -
+
+
#string Event :
+
+
+ -
+
+
#string To :
+
+
+
+
+
+
+-
+
MISSION:OnAfterStart(From, Event, To)
@@ -1581,6 +1649,42 @@ The To State string.
#boolean:
Return false to cancel Transition.
+
+
+
+-
+
+
+MISSION:OnBeforeMissionGoals(From, Event, To)
+
+
+-
+
+
MissionGoals Handler OnBefore for MISSION
+
+ Parameters
+
+ -
+
+
#string From :
+
+
+ -
+
+
#string Event :
+
+
+ -
+
+
#string To :
+
+
+
+ Return value
+
+#boolean:
+
+
@@ -2325,6 +2429,27 @@ The delay in seconds.
-
+
+MISSION:__MissionGoals(Delay)
+
+
+-
+
+
MissionGoals Asynchronous Trigger for MISSION
+
+ Parameter
+
+ -
+
+
#number Delay :
+
+
+
+
+
+
+-
+
MISSION:__Start(Delay)
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html
index dee30da78..1f63adeda 100644
--- a/docs/Documentation/Point.html
+++ b/docs/Documentation/Point.html
@@ -331,24 +331,6 @@
| COORDINATE:IsLOS(ToCoordinate) |
Returns if a Coordinate has Line of Sight (LOS) with the ToCoordinate.
- |
-
-
- | COORDINATE:IsModeA2A() |
-
- Is the mode to A2A
- |
-
-
- | COORDINATE:IsModeA2G() |
-
- Is the mode to A2G
- |
-
-
- | COORDINATE.Mode |
-
-
|
@@ -385,18 +367,6 @@
| COORDINATE:SetHeading(Heading) |
- |
-
-
- | COORDINATE:SetModeA2A() |
-
- Set the mode to A2A
- |
-
-
- | COORDINATE:SetModeA2G() |
-
- Set the mode to A2G
|
@@ -1698,56 +1668,6 @@ The Vec3 format coordinate.
#boolean:
true If the ToCoordinate has LOS with the Coordinate, otherwise false.
-
-
-
--
-
-
-COORDINATE:IsModeA2A()
-
-
--
-
-
Is the mode to A2A
-
- Return value
-
-#boolean:
-
-
-
-
-
--
-
-
-COORDINATE:IsModeA2G()
-
-
--
-
-
Is the mode to A2G
-
- Return value
-
-#boolean:
-
-
-
-
-
--
-
- #string
-
-COORDINATE.Mode
-
-
--
-
-
-
@@ -1957,42 +1877,6 @@ The route point.
-
-
-COORDINATE:SetModeA2A()
-
-
--
-
-
Set the mode to A2A
-
- Return value
-
-#COORDINATE:
-
-
-
-
-
--
-
-
-COORDINATE:SetModeA2G()
-
-
--
-
-
Set the mode to A2G
-
- Return value
-
-#COORDINATE:
-
-
-
-
-
--
-
COORDINATE:Smoke(SmokeColor)
@@ -2883,6 +2767,7 @@ The y coordinate.
-
+
POINT_VEC2.z
diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html
index 93a2ea611..2c1c82608 100644
--- a/docs/Documentation/Radio.html
+++ b/docs/Documentation/Radio.html
@@ -235,7 +235,7 @@ This uses the very generic singleton function "trigger.action.radioTransmission(
| RADIO.Loop |
-
+ (default true)
|
@@ -781,7 +781,7 @@ self
-
-
+
(default true)
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html
index c96559421..0ce1033f1 100644
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@@ -2549,6 +2549,9 @@ when nothing was spawned.
+
+ By default, no InitLimit
+
@@ -2584,7 +2587,7 @@ when nothing was spawned.
-
-
+ #number
SPAWN.SpawnMaxGroups
@@ -2601,7 +2604,7 @@ when nothing was spawned.
-
-
+ #number
SPAWN.SpawnMaxUnitsAlive
@@ -2929,7 +2932,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
-
-
+ #boolean
SPAWN.SpawnUnControlled
diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html
index 018cdd833..765a0449d 100644
--- a/docs/Documentation/Spot.html
+++ b/docs/Documentation/Spot.html
@@ -766,6 +766,7 @@ true if it is lasing
-
+
SPOT.ScheduleID
@@ -779,6 +780,7 @@ true if it is lasing
-
+
SPOT.SpotIR
@@ -792,6 +794,7 @@ true if it is lasing
-
+
SPOT.SpotLaser
@@ -805,6 +808,7 @@ true if it is lasing
-
+
SPOT.Target
diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html
index 5740dc732..551956b7a 100644
--- a/docs/Documentation/Task_Cargo.html
+++ b/docs/Documentation/Task_Cargo.html
@@ -215,6 +215,12 @@ and various dedicated deployment zones.
| TASK_CARGO:GetPlannedMenuText() |
+ |
+
+
+ | TASK_CARGO:GetSmokeColor() |
+
+
|
@@ -275,6 +281,18 @@ and various dedicated deployment zones.
| TASK_CARGO:SetScoreOnSuccess(Text, Score, TaskUnit) |
Set a score when all the targets in scope of the A2G attack, have been destroyed.
+ |
+
+
+ | TASK_CARGO.SetSmokeColor(Color, self, SmokeColor) |
+
+
+ |
+
+
+ | TASK_CARGO.SmokeColor |
+
+
|
@@ -506,7 +524,7 @@ based on the tasking capabilities defined in Task#TA
-
- Core.Cargo#CARGO_GROUP
+
FSM_PROCESS.Cargo
@@ -629,6 +647,22 @@ Core.Zone#ZONE_BASE> The Deployment Zones.
+
+
+
+-
+
+
+TASK_CARGO:GetSmokeColor()
+
+
+-
+
+
+
+
+
@return SmokeColor
+
@@ -970,6 +1004,52 @@ The score in points.
#TASK_CARGO:
+
+
+
+-
+
+
+TASK_CARGO.SetSmokeColor(Color, self, SmokeColor)
+
+
+-
+
+
+
+
Parameters
+
+
+
+
+-
+
+
+
+TASK_CARGO.SmokeColor
+
+
+-
+
+
+