diff --git a/Documentation/Base.html b/Documentation/Base.html
index 53a908d0f..c691d7457 100644
--- a/Documentation/Base.html
+++ b/Documentation/Base.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO
CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp
Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client
- DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines The CLIENT models client units in multi player missions.
-Clients are those groups defined within the Mission Editor that have the skillset defined as "Client" or "Player".
-Note that clients are NOT the same as groups, they are NOT necessarily alive.
+
+
+Clients are those Units defined within the Mission Editor that have the skillset defined as Client or Player .
+Note that clients are NOT the same as Units, they are NOT necessarily alive.
+
+Clients are being used by the MISSION class to follow players and register their successes.
+
+CLIENT construction methods:
+Create a new CLIENT object with the CLIENT.New method:
+
+
+ CLIENT.New : Creates a new CLIENT object taking the name of the DCSUnit that is a client as defined within the mission editor.
+
Global(s)
@@ -77,12 +77,6 @@ Note that clients are NOT the same as groups, they are NOT necessarily alive. CLIENT
-
-
-
- ClientGroupUnit
-
@@ -158,12 +152,6 @@ Note that clients are NOT the same as groups, they are NOT necessarily alive. CLIENT.ClientGroupUnit
-
-
-
- CLIENT.ClientID
-
@@ -224,12 +212,36 @@ Note that clients are NOT the same as groups, they are NOT necessarily alive. CLIENT:GetDCSGroup()
Return the DCSGroup of a Client.
+
+
+
+ CLIENT:GetID()
+
+
+
+
+ CLIENT:GetName()
+
CLIENT:GetPointVec2()
Returns the position of the CLIENT in DCSTypes#Vec2 format..
+
+
+
+ CLIENT:GetPositionVec3()
+
+
+
+
+ CLIENT:GetTypeName()
+
@@ -289,7 +301,7 @@ Note that clients are NOT the same as groups, they are NOT necessarily alive.
CLIENT:New(ClientName, ClientBriefing)
-Use this method to register new Clients within the MOF.
+Use this method to register new Clients within a mission.
@@ -355,20 +367,6 @@ Note that clients are NOT the same as groups, they are NOT necessarily alive.
-
-
-
-
-
-ClientGroupUnit
-
-
-
-
-
-
@@ -538,6 +536,7 @@ Function.
+
CLIENT.ClientGroupID
@@ -565,7 +564,6 @@ Function.
-
CLIENT.ClientGroupUnit
@@ -574,20 +572,6 @@ Function.
-
-
-
-
-
-
-CLIENT.ClientID
-
-
-
-
-
-
@@ -759,6 +743,32 @@ Function.
DCSGroup#Group :
+
+
+
+
+
+
+CLIENT:GetID()
+
+
+
+
+
+
+
+
+
+
+
+
+CLIENT:GetName()
+
+
+
+
+
+
@@ -777,6 +787,32 @@ Function.
DCSTypes#Vec2 :
+
+
+
+
+
+
+CLIENT:GetPositionVec3()
+
+
+
+
+
+
+
+
+
+
+
+
+CLIENT:GetTypeName()
+
+
+
+
+
+
@@ -958,14 +994,14 @@ is the interval in seconds between the display of the CARGO
CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK
DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK
DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK
@@ -46,19 +35,18 @@
MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines
- DATABASE.AlivePlayers
-
-
-
-
DATABASE.ClassName
- DATABASE.ClientsByID DATABASE.Clients
- DATABASE.ClientsByName DATABASE.ClientsAlive
@@ -253,9 +235,27 @@ The following iterator methods are currently available within the DATABASE:
- DATABASE:ForEachAliveUnit(IteratorFunction, ...) DATABASE:ForEach(IteratorFunction, arg, Set)
+Interate the DATABASE and call an interator function for the given set, providing the Object for each element within the set and optional parameters.
+
+
+
+ DATABASE:ForEachClient(IteratorFunction, ...)
+Interate the DATABASE and call an interator function for each client, providing the Client to the function and optional parameters.
+
+
+
+ DATABASE:ForEachDCSUnitAlive(IteratorFunction, ...)
Interate the DATABASE and call an interator function for each alive unit, providing the Unit and optional parameters.
+
+
+
+ DATABASE:ForEachPlayer(IteratorFunction, ...)
+Interate the DATABASE and call an interator function for each alive player, providing the Unit of the player and optional parameters.
@@ -268,6 +268,12 @@ The following iterator methods are currently available within the DATABASE:
DATABASE.Groups
+
+
+
+ DATABASE.GroupsAlive
+
@@ -286,6 +292,12 @@ The following iterator methods are currently available within the DATABASE:
DATABASE.Players
+
+
+
+ DATABASE.PlayersAlive
+
@@ -310,6 +322,12 @@ The following iterator methods are currently available within the DATABASE:
DATABASE.Statics
+
+
+
+ DATABASE.Templates
+
@@ -322,6 +340,12 @@ The following iterator methods are currently available within the DATABASE:
DATABASE.Units
+
+
+
+ DATABASE.UnitsAlive
+
@@ -334,6 +358,24 @@ The following iterator methods are currently available within the DATABASE:
DATABASE:_EventOnDeadOrCrash(Event)
Handles the OnDead or OnCrash event for alive units set.
+
+
+
+ DATABASE:_EventOnPlayerEnterUnit(Event)
+Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).
+
+
+
+ DATABASE:_EventOnPlayerLeaveUnit(Event)
+Handles the OnPlayerLeaveUnit event to clean the active players table.
+
+
+
+ DATABASE:_IsAliveDCSGroup(DCSGroup)
+
@@ -346,12 +388,24 @@ The following iterator methods are currently available within the DATABASE:
DATABASE:_IsIncludeDCSUnit(DCSUnit)
+
+
+
+ DATABASE:_RegisterDatabase()
+Private method that registers all datapoints within in the mission.
DATABASE:_RegisterGroup(GroupTemplate)
-Registers new Group Templates within the DATABASE Object.
+Private method that registers new Group Templates within the DATABASE Object.
+
+
+
+ DATABASE:_RegisterPlayers()
+Private method that registers all alive players in the mission.
@@ -381,20 +435,6 @@ The following iterator methods are currently available within the DATABASE:
-
-DATABASE.AlivePlayers
-
-
-
-
-
-
-
-
-
-
-
#string
DATABASE.ClassName
@@ -410,8 +450,8 @@ The following iterator methods are currently available within the DATABASE:
-DATABASE.ClientsByID
+
+DATABASE.Clients
@@ -424,8 +464,8 @@ The following iterator methods are currently available within the DATABASE:
-DATABASE.ClientsByName
+
+DATABASE.ClientsAlive
@@ -719,8 +759,77 @@ self
-
-DATABASE:ForEachAliveUnit(IteratorFunction, ...)
+
+DATABASE:ForEach(IteratorFunction, arg, Set)
+
+
+
+
+Interate the DATABASE and call an interator function for the given set, providing the Object for each element within the set and optional parameters.
+
+ Parameters
+
+ Return value
+
+#DATABASE :
+
+
+
+
+
+
+
+DATABASE:ForEachClient(IteratorFunction, ...)
+
+
+
+
+Interate the DATABASE and call an interator function for each client, providing the Client to the function and optional parameters.
+
+ Parameters
+
+ Return value
+
+#DATABASE :
+
+
+
+
+
+
+
+DATABASE:ForEachDCSUnitAlive(IteratorFunction, ...)
@@ -751,6 +860,38 @@ self
+
+DATABASE:ForEachPlayer(IteratorFunction, ...)
+
+
+
+
+Interate the DATABASE and call an interator function for each alive player, providing the Unit of the player and optional parameters.
+
+ Parameters
+
+ Return value
+
+#DATABASE :
+
+
+
+
+
+
DATABASE:GetStatusGroup(GroupName)
@@ -781,6 +922,20 @@ self
+
+
+
+
+
+
+DATABASE.GroupsAlive
+
+
+
+
+
+
@@ -831,6 +986,20 @@ DBObject = DATABASE:New()
+
+
+
+
+
+
+DATABASE.PlayersAlive
+
+
+
+
+
+
@@ -892,10 +1061,15 @@ This method is used by the SPAWN class.
- SpawnTemplate
+#table SpawnTemplate
+ Return value
+
+#DATABASE :
+
@@ -910,6 +1084,20 @@ This method is used by the SPAWN class.
+
+
+
+
+
+
+DATABASE.Templates
+
+
+
+
+
+
@@ -945,6 +1133,20 @@ self
+
+
+
+
+
+
+DATABASE.UnitsAlive
+
+
+
+
+
+
@@ -992,6 +1194,74 @@ self
+
+DATABASE:_EventOnPlayerEnterUnit(Event)
+
+
+
+
+Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).
+
+ Parameter
+
+
+
+
+
+
+
+DATABASE:_EventOnPlayerLeaveUnit(Event)
+
+
+
+
+Handles the OnPlayerLeaveUnit event to clean the active players table.
+
+ Parameter
+
+
+
+
+
+
+
+DATABASE:_IsAliveDCSGroup(DCSGroup)
+
+
+
+
+
+
+ Parameter
+
+ Return value
+
+#DATABASE :
+
+
+
+
+
+
DATABASE:_IsAliveDCSUnit(DCSUnit)
@@ -1044,22 +1314,63 @@ self
+
+DATABASE:_RegisterDatabase()
+
+
+
+
+Private method that registers all datapoints within in the mission.
+
+ Return value
+
+#DATABASE :
+
+
+
+
+
+
DATABASE:_RegisterGroup(GroupTemplate)
-Registers new Group Templates within the DATABASE Object.
+Private method that registers new Group Templates within the DATABASE Object.
Parameter
- GroupTemplate
+#table GroupTemplate
+ Return value
+
+#DATABASE :
+
+
+
+
+
+
+
+DATABASE:_RegisterPlayers()
+
+
+
+
+Private method that registers all alive players in the mission.
+
+ Return value
+
+#DATABASE :
+
diff --git a/Documentation/Escort.html b/Documentation/Escort.html
index d38a27767..b1fe8f549 100644
--- a/Documentation/Escort.html
+++ b/Documentation/Escort.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines EVENT:OnPilotDeadForUnit(EventDCSUnitName, EventFunction, EventSelf)
Set a new listener for an SEVENT PILOT_DEAD event.
+
+
+
+ EVENT:OnPlayerEnterUnit(EventFunction, EventSelf)
+Set a new listener for an SEVENT PLAYERENTER UNIT event.
+
+
+
+ EVENT:OnPlayerLeaveUnit(EventFunction, EventSelf)
+Set a new listener for an SEVENT PLAYERLEAVE UNIT event.
@@ -1259,6 +1259,72 @@ The self instance of the class for which the event is.
#EVENT :
+
+
+
+
+
+
+EVENT:OnPlayerEnterUnit(EventFunction, EventSelf)
+
+
+
+
+Set a new listener for an SEVENT PLAYERENTER UNIT event.
+
+ Parameters
+
+ Return value
+
+#EVENT :
+
+
+
+
+
+
+
+
+EVENT:OnPlayerLeaveUnit(EventFunction, EventSelf)
+
+
+
+
+Set a new listener for an SEVENT PLAYERLEAVE UNIT event.
+
+ Parameters
+
+ Return value
+
+#EVENT :
+
+
diff --git a/Documentation/GOHOMETASK.html b/Documentation/GOHOMETASK.html
index b1ebecdcd..4b63dc32e 100644
--- a/Documentation/GOHOMETASK.html
+++ b/Documentation/GOHOMETASK.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines GROUP:CommandDoScript(DoScript)
Do Script command
+
+
+
+ GROUP:CommandSwitchWayPoint(FromWayPoint, ToWayPoint, Index)
+Perform a switch waypoint command
@@ -209,7 +203,7 @@ Note that this destroy method also raises a destroy event at run-time.
GROUP:GetName()
-Gets the name of the GROUP.
+Returns the name of the Group.
@@ -462,12 +456,24 @@ Note that this destroy method also raises a destroy event at run-time.
GROUP:Route(GoPoints)
Make the group to follow a given route.
+
+
+
+ GROUP:SetCommand(DCSCommand)
+Executes a command action
GROUP:SetTask(DCSTask, WaitTime)
Clearing the Task Queue and Setting the Task on the queue from the group.
+
+
+
+ GROUP:TaskAttackGroup(AttackGroup)
+Attack a Group.
@@ -751,6 +757,42 @@ All units on the ground result.
#DCSCommand :
+
+
+
+
+
+
+GROUP:CommandSwitchWayPoint(FromWayPoint, ToWayPoint, Index)
+
+
+
+
+Perform a switch waypoint command
+
+ Parameters
+
+
+
+#number FromWayPoint
+
+
+
+
+#number ToWayPoint
+
+
+
+
+ Index
+
+
+
+ Return value
+
+DCSTask#Task :
+
+
@@ -1075,12 +1117,12 @@ Minimum height found.
-Gets the name of the GROUP.
+Returns the name of the Group.
Return value
#string:
-The name of the GROUP.
+GroupName
@@ -1975,6 +2017,32 @@ self
+
+GROUP:SetCommand(DCSCommand)
+
+
+
+
+Executes a command action
+
+ Parameter
+
+ Return value
+
+#GROUP :
+
+
+
+
+
+
GROUP:SetTask(DCSTask, WaitTime)
@@ -2006,6 +2074,33 @@ self
+
+GROUP:TaskAttackGroup(AttackGroup)
+
+
+
+
+Attack a Group.
+
+ Parameter
+
+ Return value
+
+DCSTask#Task :
+
+
+
+
+
+
GROUP:TaskAttackUnit(The, AttackUnit)
diff --git a/Documentation/MISSION.html b/Documentation/MISSION.html
index 81752775f..9de091e4d 100644
--- a/Documentation/MISSION.html
+++ b/Documentation/MISSION.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT
Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu
Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines MENU_CLIENT_COMMAND
+
+
+
+ MENU_COALITION
+
+
+
+
+ MENU_COALITION_COMMAND
+
@@ -208,6 +208,56 @@
MENU_CLIENT_COMMAND:Remove()
+
+
+
+
+
+
+
+ #MENU_COALITION
+
+
+
+
+
+
+
+
+
+ #MENU_COALITION_COMMAND
+MENU_COALITION_COMMAND
+
+
+
+
+
+
@@ -645,6 +723,190 @@ self
+
+
+
+ The MENU_COALITION class
+
+ Field(s)
+
+
+
+ #string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Creates a new coalition menu item
+
+ Parameters
+
+
+
+DCSCoalition#coalition.side MenuCoalition
+
+
+
+
+#string MenuText
+
+
+
+
+#table ParentMenu
+
+
+
+ Return value
+
+#MENU_COALITION :
+
+
+
+
+
+
+
+
+
+
+Removes the sub menus recursively of this MENU_COALITION.
+
+ Return value
+
+#MENU_COALITION :
+
+
+
+
+
+
+
+
+
+
+Removes the sub menus recursively of this MENU_COALITION.
+
+ Return value
+
+#MENU_COALITION :
+
+
+
+
+
+
+The MENUCOALITION COMMAND class
+
+ Field(s)
+
+
+
+ #string
+
+MENU_COALITION_COMMAND.ClassName
+
+
+
+
+
+
+
+
+
+
+
+
+MENU_COALITION_COMMAND:New(MenuCoalition, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument)
+
+
+
+
+Creates a new radio command item for a group
+
+ Parameters
+
+
+
+DCSCoalition#coalition.side MenuCoalition
+
+
+
+
+ MenuText
+
+
+
+
+ ParentMenu
+
+
+
+
+ CommandMenuFunction
+
+
+
+
+ CommandMenuArgument
+
+
+
+ Return value
+
+#MENUCOALITION COMMAND :
+
+
+
+
+
+
+
+MENU_COALITION_COMMAND:Remove()
+
+
+
+
+Removes a radio command item for a coalition
+
+ Return value
+
+#MENUCOALITION COMMAND :
+
diff --git a/Documentation/Message.html b/Documentation/Message.html
index 66c9d6c91..dd4087bf7 100644
--- a/Documentation/Message.html
+++ b/Documentation/Message.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message
+ MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines
+
+
+
+
+
Module MissileTrainer
+
+
Provides missile training functions.
+
+
+
+
+
The #MISSILETRAINER class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
+the class will destroy the missile within a certain range, to avoid damage to your aircraft.
+It suports the following functionality:
+
+
+ Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
+ Provide alerts of missile launches, including detailed information of the units launching, including bearing, range …
+ Provide alerts when a missile would have killed your aircraft.
+ Provide alerts when the missile self destructs.
+ Enable / Disable and Configure the Missile Trainer using the various menu options.
+
+
+
MISSILETRAINER construction methods:
+
Create a new MISSILETRAINER object with the MISSILETRAINER.New method:
+
+
+ MISSILETRAINER.New : Creates a new MISSILETRAINER object taking the maximum distance to your aircraft to evaluate when a missile needs to be destroyed.
+
+
MISSILETRAINER will collect each unit declared in the mission with a skill level "Client" and "Player", and will monitor the missiles shot at those.
+
+
MISSILETRAINER initialization methods:
+
A MISSILETRAINER object will behave differently based on the usage of initialization methods:
+
+
+
+
+
Global(s)
+
+
+
+
+
Global(s)
+
+
+
+ #MISSILETRAINER
+MISSILETRAINER
+
+
+
+
+
+
+
+
+
+
+
+
+
The MISSILETRAINER class
+
+
Field(s)
+
+
+
+
+MISSILETRAINER.AlertsHitsOnOff
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER.AlertsLaunchesOnOff
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER.AlertsToAll
+
+
+
+
+
+
+
+
+
+
+
+ #string
+
+MISSILETRAINER.ClassName
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER.DetailsBearingOnOff
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER.DetailsRangeOnOff
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER:InitAlertsHitsOnOff(AlertsHitsOnOff)
+
+
+
+
+Sets by default the display of hit alerts ON or OFF.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER:InitAlertsLaunchesOnOff(AlertsLaunchesOnOff)
+
+
+
+
+Sets by default the display of launch alerts ON or OFF.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER:InitAlertsToAll(AlertsToAll)
+
+
+
+
+Sets by default the display of alerts to be shown to all players or only to you.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER:InitBearingOnOff(DetailsBearingOnOff)
+
+
+
+
+Sets by default the display of bearing information of missiles ON of OFF.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER:InitMessagesOnOff(MessagesOnOff)
+
+
+
+
+Sets by default the display of any message to be ON or OFF.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER:InitRangeOnOff(DetailsRangeOnOff)
+
+
+
+
+Sets by default the display of range information of missiles ON of OFF.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER:InitTrackingOnOff(TrackingOnOff)
+
+
+
+
+Sets by default the display of missile tracking report to be ON or OFF.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER:InitTrackingToAll(TrackingToAll)
+
+
+
+
+Sets by default the missile tracking report for all players or only for those missiles targetted to you.
+
+ Parameter
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+MISSILETRAINER.MessageLastTime
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER.MessagesOnOff
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER.New(#, Distance, self)
+
+
+
+
+Creates the main object which is handling missile tracking.
+
+
+When a missile is fired a SCHEDULER is set off that follows the missile. When near a certain a client player, the missile will be destroyed.
+
+ Parameters
+
+ Return value
+
+#MISSILETRAINER :
+
+
+
+
+
+
+
+
+MISSILETRAINER.TrackingOnOff
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER.TrackingToAll
+
+
+
+
+
+
+
+
+
+
+
+
+MISSILETRAINER:_AddBearing(Client, TrainerWeapon)
+
+
+
+
+
+
+ Parameters
+
+
+
+ Client
+
+
+
+
+ TrainerWeapon
+
+
+
+
+
+
+
+
+
+MISSILETRAINER:_AddRange(Client, TrainerWeapon)
+
+
+
+
+
+
+ Parameters
+
+
+
+ Client
+
+
+
+
+ TrainerWeapon
+
+
+
+
+
+
+
+
+
+MISSILETRAINER:_EventShot(Event)
+
+
+
+
+Detects if an SA site was shot with an anti radiation missile.
+
+
+In this case, take evasive actions based on the skill level set within the ME.
+
+ Parameter
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameter
+
+
+
+ MenuParameters
+
+
+
+
+
+
+
+
+
+MISSILETRAINER:_TrackMissiles()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/Documentation/NOTASK.html b/Documentation/NOTASK.html
index 4fa604429..d49ebedf5 100644
--- a/Documentation/NOTASK.html
+++ b/Documentation/NOTASK.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client
-
DCSAirbase
-
DCSCoalitionObject
-
DCSCommand
-
DCSController
-
DCSGroup
-
DCSObject
-
DCSTask
-
DCSTypes
-
DCSUnit
-
DCSWorld
-
DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK
@@ -46,19 +35,18 @@
MOVEMENT Menu Message
+
MissileTrainer NOTASK
PICKUPTASK ROUTETASK STAGE
+
Scheduler Scoring Sead Spawn
-
StaticObject TASK Unit Zone
-
env
-
land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK
ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK
STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE
+ Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines
+
+
+
+
+
Module Scheduler
+
+
Models time events calling event handing functions.
+
+
Global(s)
+
+
+
+
+
Global(s)
+
+
+
+ #SCHEDULER
+SCHEDULER
+
+
+
+
+
+
+
+
+
+
+
+
+
The SCHEDULER class
+
+
Field(s)
+
+
+
+ #string
+
+SCHEDULER.ClassName
+
+
+
+
+
+
+
+
+
+
+
+
+SCHEDULER:New(TimeEventObject, TimeEventFunction, TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds)
+
+
+
+
+SCHEDULER constructor.
+
+ Parameters
+
+
+
+#table TimeEventObject
+
+
+
+
+#function TimeEventFunction
+
+
+
+
+#table TimeEventFunctionArguments
+
+
+
+
+#number StartSeconds
+
+
+
+
+#number RepeatSecondsInterval
+
+
+
+
+#number RandomizationFactor
+
+
+
+
+#number StopSeconds
+
+
+
+ Return value
+
+#SCHEDULER :
+
+
+
+
+
+
+
+
+SCHEDULER:Scheduler()
+
+
+
+
+
+
+
+
+
+
+
+
+SCHEDULER:Start()
+
+
+
+
+
+
+
+
+
+
+
+
+SCHEDULER:Stop()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/Documentation/Scoring.html b/Documentation/Scoring.html
index b70b673fb..34d058056 100644
--- a/Documentation/Scoring.html
+++ b/Documentation/Scoring.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client
-
DCSAirbase
-
DCSCoalitionObject
-
DCSCommand
-
DCSController
-
DCSGroup
-
DCSObject
-
DCSTask
-
DCSTypes
-
DCSUnit
-
DCSWorld
-
DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK
@@ -46,19 +35,18 @@
MOVEMENT Menu Message
+
MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE
+
Scheduler Scoring
Sead Spawn
-
StaticObject TASK Unit Zone
-
env
-
land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead
Spawn StaticObject TASK Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn
- StaticObject TASK Unit Zone env land routines SPAWN.RandomizeTemplate : Randomize the group templates so that when a new group is spawned, a random group template is selected from one of the templates defined. SPAWN.Uncontrolled : Spawn plane groups uncontrolled.SPAWN.Array : Make groups visible before they are actually activated, and order these groups like a batallion in an array.SPAWN.Repeat : Re-spawn groups when they land at the home base. Similar functions are SPAWN.RepeatOnLanding and SPAWN.RepeatOnEngineShutDown .SPAWN.InitRepeat : Re-spawn groups when they land at the home base. Similar functions are SPAWN.InitRepeatOnLanding and SPAWN.InitRepeatOnEngineShutDown .SPAWN spawning methods:
@@ -158,12 +146,6 @@ Check the SPAWN.CleanUp for further info.
- SPAWN.AliveFactor
-
-
-
-
SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)
Makes the groups visible before start (like a batallion).
@@ -182,7 +164,7 @@ Check the SPAWN.CleanUp for further info.
- SPAWN.CleanUpFunction SPAWN.CleanUpScheduler
@@ -215,6 +197,24 @@ Check the SPAWN.CleanUp for further info.
SPAWN:GetSpawnIndexFromGroup(SpawnGroup)
Get the index from a given group.
+
+
+
+ SPAWN:InitRepeat()
+For planes and helicopters, when these groups go home and land on their home airbases and farps, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.
+
+
+
+ SPAWN:InitRepeatOnEngineShutDown()
+Respawn after landing when its engines have shut down.
+
+
+
+ SPAWN:InitRepeatOnLanding()
+Respawn group after landing.
@@ -254,9 +254,9 @@ Check the SPAWN.CleanUp for further info.
- SPAWN:Repeat() SPAWN.Repeat
-For planes and helicopters, when these groups go home and land on their home airbases and farps, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.
+
@@ -293,12 +293,6 @@ Check the SPAWN.CleanUp for further info.
SPAWN.SpawnCleanUpTimeStamps
-
-
-
- SPAWN.SpawnCurrentTimer
-
@@ -329,24 +323,12 @@ Check the SPAWN.CleanUp for further info.
SPAWN:SpawnGroupName(SpawnIndex)
Will return the SpawnGroupName either with with a specific count number or without any count.
-
-
-
- SPAWN.SpawnHighTimer
-
SPAWN:SpawnInZone(Zone, ZoneRandomize, SpawnIndex)
Will spawn a Group within a given Zone#ZONE .
-
-
-
- SPAWN.SpawnLowTimer
-
@@ -389,18 +371,12 @@ Check the SPAWN.CleanUp for further info.
SPAWN.SpawnRandomizeTemplate
-
-
-
- SPAWN.SpawnRepeat
-
SPAWN:SpawnScheduleStart()
-Will start the spawning scheduler.
+Will re-start the spawning scheduler.
@@ -416,7 +392,7 @@ Check the SPAWN.CleanUp for further info.
- SPAWN.SpawnSetTimer SPAWN.SpawnScheduler
@@ -550,13 +526,13 @@ Check the SPAWN.CleanUp for further info.
SPAWN:_RandomizeRoute(SpawnIndex)
-Internal function randomizing the routes.
+Private method randomizing the routes.
SPAWN:_RandomizeTemplate(SpawnIndex)
-
+Private method that randomizes the template of the group.
@@ -604,20 +580,6 @@ Check the SPAWN.CleanUp for further info.
- #number
-
-SPAWN.AliveFactor
-
-
-
-
-
-
-
-
-
-
-
SPAWN:Array(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)
@@ -721,14 +683,17 @@ self
-SPAWN.CleanUpFunction
+
+SPAWN.CleanUpScheduler
+
+self.CleanUpFunction = routines.scheduleFunction( self._SpawnCleanUpScheduler, { self }, timer.getTime() + 1, SpawnCleanUpInterval )
+
@@ -876,6 +841,71 @@ When no group is found, #nil is returned.
+
+SPAWN:InitRepeat()
+
+
+
+
+For planes and helicopters, when these groups go home and land on their home airbases and farps, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.
+
+
+This function is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has landed.
+This will enable a spawned group to be re-spawned after it lands, until it is destroyed...
+Note: When the group is respawned, it will re-spawn from the original airbase where it took off.
+So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...
+
+ Return value
+
+#SPAWN :
+
+ Usage:
+ -- RU Su-34 - AI Ship Attack
+-- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
+SpawnRU_SU34 = SPAWN:New( 'TF1 RU Su-34 Krymsk@AI - Attack Ships' ):Schedule( 2, 3, 1800, 0.4 ):SpawnUncontrolled():RandomizeRoute( 1, 1, 3000 ):RepeatOnEngineShutDown()
+
+
+
+
+
+SPAWN:InitRepeatOnEngineShutDown()
+
+
+
+
+Respawn after landing when its engines have shut down.
+
+ Return value
+
+#SPAWN :
+
+
+
+
+
+
+
+SPAWN:InitRepeatOnLanding()
+
+
+
+
+Respawn group after landing.
+
+ Return value
+
+#SPAWN :
+
+
+
+
+
+
SPAWN:Limit(SpawnMaxUnitsAlive, SpawnMaxGroups)
@@ -1123,29 +1153,14 @@ The group that was spawned. You can use this group for further actions.
+ #boolean
-SPAWN:Repeat()
+SPAWN.Repeat
-For planes and helicopters, when these groups go home and land on their home airbases and farps, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.
-
-This function is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has landed.
-This will enable a spawned group to be re-spawned after it lands, until it is destroyed...
-Note: When the group is respawned, it will re-spawn from the original airbase where it took off.
-So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...
-
- Return value
-
-#SPAWN :
-
- Usage:
- -- RU Su-34 - AI Ship Attack
--- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
-SpawnRU_SU34 = SPAWN:New( 'TF1 RU Su-34 Krymsk@AI - Attack Ships' ):Schedule( 2, 3, 1800, 0.4 ):SpawnUncontrolled():RandomizeRoute( 1, 1, 3000 ):RepeatOnEngineShutDown()
@@ -1238,23 +1253,6 @@ The group that was spawned. You can use this group for further actions.
-
-
-
-
-
- #number
-
-SPAWN.SpawnCurrentTimer
-
-
-
-
-
-
-
- The internal timer counter to trigger a scheduled spawning of SpawnTemplatePrefix.
-
@@ -1412,20 +1410,6 @@ Is the number of the Group that is to be spawned.
#string:
SpawnGroupName
-
-
-
-
-
- #number
-
-SPAWN.SpawnHighTimer
-
-
-
-
-
-
@@ -1479,20 +1463,6 @@ when nothing was spawned.
-
-
-
-
-
- #number
-
-SPAWN.SpawnLowTimer
-
-
-
-
-
-
@@ -1597,20 +1567,6 @@ when nothing was spawned.
-
-
-
-
-
- #boolean
-
-SPAWN.SpawnRepeat
-
-
-
-
-
-
@@ -1622,10 +1578,10 @@ when nothing was spawned.
-Will start the spawning scheduler.
+Will re-start the spawning scheduler.
-Note: This function is called automatically when SPAWN.Scheduled is called.
+Note: This function is only required to be called when the schedule was stopped.
@@ -1692,18 +1648,15 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- #number
-
-SPAWN.SpawnSetTimer
+
+SPAWN.SpawnScheduler
-
- The internal timer value when a scheduled spawning of SpawnTemplatePrefix occurs.
-
@@ -2022,10 +1975,15 @@ Nothing found
+ Return value
+
+
+@SPAWN self
+
@@ -2184,15 +2142,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
- SpawnTemplatePrefix
+#string SpawnTemplatePrefix
- SpawnIndex
+#number SpawnIndex
+ Return value
+
+#SPAWN :
+
@@ -2204,7 +2167,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-Internal function randomizing the routes.
+Private method randomizing the routes.
Parameter
diff --git a/Documentation/TASK.html b/Documentation/TASK.html
index bc244726c..d18c673ff 100644
--- a/Documentation/TASK.html
+++ b/Documentation/TASK.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK
Unit Zone env land routines CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit
Zone env land routines UNIT:GetName()
+
+
+
+ UNIT:GetPlayerName()
+
@@ -510,6 +504,19 @@
+
+
+
+
+
+
+UNIT:GetPlayerName()
+
+
+
+
+
+
diff --git a/Documentation/Zone.html b/Documentation/Zone.html
index 1b9c3cb4b..ca4efd886 100644
--- a/Documentation/Zone.html
+++ b/Documentation/Zone.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone
- env land routines ZONE:GetPointVec2()
+
+
+
+ ZONE:GetPointVec3(Height)
+
@@ -157,6 +151,27 @@
+
+
+
+
+
+
+ZONE:GetPointVec3(Height)
+
+
+
+
+
+
+ Parameter
+
diff --git a/Documentation/index.html b/Documentation/index.html
index 0464d0694..6900f9112 100644
--- a/Documentation/index.html
+++ b/Documentation/index.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines Client
The CLIENT models client units in multi player missions.
-
-
-
- DCSAirbase
-
-
-
-
- DCSCoalitionObject
-
-
-
-
- DCSCommand
-
-
-
-
- DCSController
-
-
-
-
- DCSGroup
-
-
-
-
- DCSObject
-
-
-
-
- DCSTask
-
-
-
-
- DCSTypes
-
-
-
-
- DCSUnit
-
-
-
-
- DCSWorld
-
-
-
-
- DCStimer
-
@@ -237,6 +159,12 @@
Message
Message System to display Messages for Clients and Coalitions or All.
+
+
+
+ MissileTrainer
+Provides missile training functions.
@@ -261,6 +189,12 @@
STAGE
Stages within a TASK within a MISSION .
+
+
+
+ Scheduler
+Models time events calling event handing functions.
@@ -279,12 +213,6 @@
Spawn
Dynamic spawning of groups (and units).
-
-
-
- StaticObject
-
@@ -303,18 +231,6 @@
Zone
ZONE Classes
-
-
-
- env
-
-
-
-
- land
-
diff --git a/Documentation/routines.html b/Documentation/routines.html
index d33caf801..806bd57e3 100644
--- a/Documentation/routines.html
+++ b/Documentation/routines.html
@@ -21,17 +21,6 @@
CARGO CleanUp Client DCSAirbase DCSCoalitionObject DCSCommand DCSController DCSGroup DCSObject DCSTask DCSTypes DCSUnit DCSWorld DCStimer DEPLOYTASK DESTROYBASETASK DESTROYGROUPSTASK MOVEMENT Menu Message MissileTrainer NOTASK PICKUPTASK ROUTETASK STAGE Scheduler Scoring Sead Spawn StaticObject TASK Unit Zone env land routines
diff --git a/Moose/Client.lua b/Moose/Client.lua
index de9883743..f608e8673 100644
--- a/Moose/Client.lua
+++ b/Moose/Client.lua
@@ -2,10 +2,10 @@
--
-- @{#CLIENT} class
-- ================
--- Clients are those units defined within the Mission Editor that have the skillset defined as "Client" or "Player".
--- Note that clients are NOT the same as units, they are NOT necessarily alive.
+-- Clients are those **Units** defined within the Mission Editor that have the skillset defined as __Client__ or __Player__.
+-- Note that clients are NOT the same as Units, they are NOT necessarily alive.
--
--- Clients are being used in a mission and tasks to follow players and their successes.
+-- Clients are being used by the @{MISSION} class to follow players and register their successes.
--
-- CLIENT construction methods:
-- ============================
@@ -315,7 +315,7 @@ end
function CLIENT:GetPointVec2()
self:F()
- ClientGroupUnit = self:GetClientGroupDCSUnit()
+ local ClientGroupUnit = self:GetClientGroupDCSUnit()
if ClientGroupUnit then
if ClientGroupUnit:isExist() then
@@ -376,7 +376,7 @@ end
function CLIENT:ClientPosition()
self:F()
- ClientGroupUnit = self:GetClientGroupDCSUnit()
+ local ClientGroupUnit = self:GetClientGroupDCSUnit()
if ClientGroupUnit then
if ClientGroupUnit:isExist() then
@@ -393,7 +393,7 @@ end
function CLIENT:GetAltitude()
self:F()
- ClientGroupUnit = self:GetClientGroupDCSUnit()
+ local ClientGroupUnit = self:GetClientGroupDCSUnit()
if ClientGroupUnit then
if ClientGroupUnit:isExist() then
diff --git a/Test Missions/Moose_Test_MISSILETRAINER/Moose_Test_MISSILETRAINER.lua b/Test Missions/Moose_Test_MISSILETRAINER/Moose_Test_MISSILETRAINER.lua
index 2aaabf1ff..618442f13 100644
--- a/Test Missions/Moose_Test_MISSILETRAINER/Moose_Test_MISSILETRAINER.lua
+++ b/Test Missions/Moose_Test_MISSILETRAINER/Moose_Test_MISSILETRAINER.lua
@@ -1,6 +1,19 @@
-
-Include.File("Moose")
+-- Only use Include.File when developing new MOOSE classes.
+-- When using Moose.lua in the DO SCIPTS FILE initialization box,
+-- these Include.File statements are not needed, because all classes within Moose will be loaded.
Include.File("MissileTrainer")
-local Trainer = MISSILETRAINER:New( 200 )
\ No newline at end of file
+-- This is an example of a global
+local Trainer = MISSILETRAINER
+ :New( 200 )
+ :InitMessagesOnOff(true)
+ :InitAlertsToAll(false) -- I'll correct it below ...
+ :InitAlertsHitsOnOff(true)
+ :InitAlertsLaunchesOnOff(true)
+ :InitBearingOnOff(true)
+ :InitRangeOnOff(true)
+ :InitTrackingOnOff(true)
+ :InitTrackingToAll(true)
+
+Trainer:InitAlertsHitsOnOff(true) -- Now alerts are also on