diff --git a/Moose Training/Documentation/Base.html b/Moose Training/Documentation/Base.html index f7177aa41..c35a7adac 100644 --- a/Moose Training/Documentation/Base.html +++ b/Moose Training/Documentation/Base.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -253,7 +255,7 @@ These tracing levels were defined to avoid bulks of tracing to be generated by l BASE:New() - +

    The base constructor.

    @@ -769,7 +771,29 @@ is the Child class from which the Parent class needs to be retrieved.

    +

    The base constructor.

    + +

    This is the top top class of all classed defined within the MOOSE. +Any new class needs to be derived from this class for proper inheritance.

    + +

    Return value

    + +

    #BASE: +The new instance of the BASE class.

    + +

    Usage:

    + 
    function TASK:New()
+
+    local self = BASE:Inherit( self, BASE:New() )
+
+    -- assign Task default values during construction
+    self.TaskBriefing = "Task: No Task."
+    self.Time = timer.getTime()
+    self.ExecuteStage = _TransportExecuteStage.NONE
+
+    return self
+end
    diff --git a/Moose Training/Documentation/CARGO.html b/Moose Training/Documentation/CARGO.html index fdacc75e3..f7ca9c91e 100644 --- a/Moose Training/Documentation/CARGO.html +++ b/Moose Training/Documentation/CARGO.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/CleanUp.html b/Moose Training/Documentation/CleanUp.html index 1b0702bb3..c22bc448d 100644 --- a/Moose Training/Documentation/CleanUp.html +++ b/Moose Training/Documentation/CleanUp.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/Client.html b/Moose Training/Documentation/Client.html index 67e324e6f..7ad2cd35e 100644 --- a/Moose Training/Documentation/Client.html +++ b/Moose Training/Documentation/Client.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -309,13 +311,19 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return CLIENT:ShowBriefing() -

    Show the briefing of the MISSION to the CLIENT.

    +

    Show the briefing of a CLIENT.

    CLIENT:ShowCargo()

    Shows the Cargo#CARGO contained within the CLIENT to the player as a message.

    + + + + CLIENT:ShowMissionBriefing(MissionBriefing) + +

    Show the mission briefing of a MISSION to the CLIENT.

    @@ -992,7 +1000,7 @@ Name of the Group as defined within the Mission Editor. The Group must have a Un
    -

    Show the briefing of the MISSION to the CLIENT.

    +

    Show the briefing of a CLIENT.

    Return value

    @@ -1020,6 +1028,32 @@ self

    + +CLIENT:ShowMissionBriefing(MissionBriefing) + +
    +
    + +

    Show the mission briefing of a MISSION to the CLIENT.

    + +

    Parameter

    +
      +
    • + +

      #string MissionBriefing :

      + +
      • +
    +

    Return value

    + +

    #CLIENT: +self

    + +
    +
    +
    +
    + CLIENT.SwitchMessages(PrmTable) diff --git a/Moose Training/Documentation/DCSAirbase.html b/Moose Training/Documentation/DCSAirbase.html index 907c576e5..c5ad209a8 100644 --- a/Moose Training/Documentation/DCSAirbase.html +++ b/Moose Training/Documentation/DCSAirbase.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSCoalitionObject.html b/Moose Training/Documentation/DCSCoalitionObject.html index ee0e7b8dc..d7a968f25 100644 --- a/Moose Training/Documentation/DCSCoalitionObject.html +++ b/Moose Training/Documentation/DCSCoalitionObject.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSCommand.html b/Moose Training/Documentation/DCSCommand.html index 4c9762082..5f433a2f3 100644 --- a/Moose Training/Documentation/DCSCommand.html +++ b/Moose Training/Documentation/DCSCommand.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSController.html b/Moose Training/Documentation/DCSController.html index c4e7c7428..228983cdf 100644 --- a/Moose Training/Documentation/DCSController.html +++ b/Moose Training/Documentation/DCSController.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSGroup.html b/Moose Training/Documentation/DCSGroup.html index a7a84c8d1..d5df1b04a 100644 --- a/Moose Training/Documentation/DCSGroup.html +++ b/Moose Training/Documentation/DCSGroup.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSObject.html b/Moose Training/Documentation/DCSObject.html index 44157433f..d536b3e22 100644 --- a/Moose Training/Documentation/DCSObject.html +++ b/Moose Training/Documentation/DCSObject.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSTask.html b/Moose Training/Documentation/DCSTask.html index 93585f188..adf8812c1 100644 --- a/Moose Training/Documentation/DCSTask.html +++ b/Moose Training/Documentation/DCSTask.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSTypes.html b/Moose Training/Documentation/DCSTypes.html index 2cf9f22b0..56ccd79ff 100644 --- a/Moose Training/Documentation/DCSTypes.html +++ b/Moose Training/Documentation/DCSTypes.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSUnit.html b/Moose Training/Documentation/DCSUnit.html index e09265c44..e40060e37 100644 --- a/Moose Training/Documentation/DCSUnit.html +++ b/Moose Training/Documentation/DCSUnit.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCSWorld.html b/Moose Training/Documentation/DCSWorld.html index e91ba3f3f..13b3fe634 100644 --- a/Moose Training/Documentation/DCSWorld.html +++ b/Moose Training/Documentation/DCSWorld.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DCStimer.html b/Moose Training/Documentation/DCStimer.html index b4af45ac2..b05ff053c 100644 --- a/Moose Training/Documentation/DCStimer.html +++ b/Moose Training/Documentation/DCStimer.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DEPLOYTASK.html b/Moose Training/Documentation/DEPLOYTASK.html index b57bf41c4..53467e608 100644 --- a/Moose Training/Documentation/DEPLOYTASK.html +++ b/Moose Training/Documentation/DEPLOYTASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DESTROYBASETASK.html b/Moose Training/Documentation/DESTROYBASETASK.html index 263a03453..aa3bef726 100644 --- a/Moose Training/Documentation/DESTROYBASETASK.html +++ b/Moose Training/Documentation/DESTROYBASETASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DESTROYGROUPSTASK.html b/Moose Training/Documentation/DESTROYGROUPSTASK.html index 2235e0590..baa779ad1 100644 --- a/Moose Training/Documentation/DESTROYGROUPSTASK.html +++ b/Moose Training/Documentation/DESTROYGROUPSTASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DESTROYRADARSTASK.html b/Moose Training/Documentation/DESTROYRADARSTASK.html index f246dfc10..cab844e6f 100644 --- a/Moose Training/Documentation/DESTROYRADARSTASK.html +++ b/Moose Training/Documentation/DESTROYRADARSTASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/DESTROYUNITTYPESTASK.html b/Moose Training/Documentation/DESTROYUNITTYPESTASK.html index 62898b2ee..f5ce3a192 100644 --- a/Moose Training/Documentation/DESTROYUNITTYPESTASK.html +++ b/Moose Training/Documentation/DESTROYUNITTYPESTASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/Database.html b/Moose Training/Documentation/Database.html index baef7069e..211aacd2c 100644 --- a/Moose Training/Documentation/Database.html +++ b/Moose Training/Documentation/Database.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -68,80 +70,42 @@

    Module Database

    -

    Manage sets of units and groups.

    +

    Manage the mission database.

    -

    #Database class

    -

    Mission designers can use the DATABASE class to build sets of units belonging to certain:

    +

    #DATABASE class

    +

    Mission designers can use the DATABASE class to refer to:

      -
    • Coalitions
      • -
    • Categories
      • -
    • Countries
      • -
    • Unit types
      • -
    • Starting with certain prefix strings.
      • +
    • UNITS
      • +
    • GROUPS
      • +
    • players
      • +
    • alive players
      • +
    • CLIENTS
      • +
    • alive CLIENTS
    -

    This list will grow over time. Planned developments are to include filters and iterators. -Additional filters will be added around Zone#ZONEs, Radiuses, Active players, ... -More iterators will be implemented in the near future ...

    - -

    Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.

    - -

    DATABASE construction methods:

    -

    Create a new DATABASE object with the DATABASE.New method:

    - - - - -

    DATABASE filter criteria:

    -

    You can set filter criteria to define the set of units within the database. -Filter criteria are defined by:

    - - - -

    Once the filter criteria have been set for the DATABASE, you can start filtering using:

    - - - -

    Planned filter criteria within development are (so these are not yet available):

    - - +

    On top, for internal MOOSE administration purposes, the DATBASE administers the Unit and Gruop templates as defined within the Mission Editor.

    +

    Moose will automatically create one instance of the DATABASE class into the global object _DATABASE. +Moose refers to _DATABASE within the framework extensively, but you can also refer to the _DATABASE object within your missions if required.

    DATABASE iterators:

    -

    Once the filters have been defined and the DATABASE has been built, you can iterate the database with the available iterator methods. +

    You can iterate the database with the available iterator methods. The iterator methods will walk the DATABASE set, and call for each element within the set a function that you provide. The following iterator methods are currently available within the DATABASE:

    -

    Planned iterators methods in development are (so these are not yet available):

    - - - -
    -

    Global(s)

    @@ -163,6 +127,12 @@ The following iterator methods are currently available within the DATABASE:

    + + + + @@ -178,13 +148,13 @@ The following iterator methods are currently available within the DATABASE:

    - + - + @@ -199,24 +169,18 @@ The following iterator methods are currently available within the DATABASE:

    + + + + - - - - - - - - @@ -240,25 +204,49 @@ The following iterator methods are currently available within the DATABASE:

    + + + + + + + + + + + + + + + + @@ -286,19 +274,13 @@ The following iterator methods are currently available within the DATABASE:

    - + - - - - - + @@ -313,24 +295,12 @@ The following iterator methods are currently available within the DATABASE:

    - - - - - - - - @@ -361,24 +331,6 @@ The following iterator methods are currently available within the DATABASE:

    - - - - - - - - - - - - @@ -388,15 +340,21 @@ The following iterator methods are currently available within the DATABASE:

    - + + + + + - +
    DATABASE:AddGroup(DCSGroup, GroupName)

    Adds a GROUP based on the GroupName in the DATABASE.

    +
    DATABASE:AddPlayer(UnitName, PlayerName) +

    Adds a player based on the Player Name in the DATABASE.
    DATABASE.ClassNameDATABASE.CLIENTSALIVE
    DATABASE.ClientsAliveDATABASE.ClassName DATABASE.DCSUnits +
    DATABASE:DeletePlayer(PlayerName) +

    Deletes a player from the DATABASE based on the Player Name.
    DATABASE:DeleteUnit(DCSUnitName)

    Deletes a Unit from the DATABASE based on the Unit Name.

    -
    DATABASE.Filter - -
    DATABASE.FilterMeta -
    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.

    +

    Iterate the DATABASE and call an iterator 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.

    +

    Iterate the DATABASE and call an iterator function for each CLIENT, providing the CLIENT to the function and optional parameters.

    +
    DATABASE:ForEachClientAlive(IteratorFunction, ...) +

    Iterate the DATABASE and call an iterator function for each ALIVE CLIENT, providing the CLIENT to the function and optional parameters.
    DATABASE:ForEachDCSUnit(IteratorFunction, ...) -

    Interate the DATABASE and call an interator function for each alive unit, providing the Unit and optional parameters.

    +

    Iterate the DATABASE and call an iterator function for each alive unit, providing the DCSUnit and optional parameters.

    +
    DATABASE:ForEachGroup(IteratorFunction, ...) +

    Iterate the DATABASE and call an iterator function for each alive GROUP, providing the GROUP 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.

    +

    Iterate the DATABASE and call an iterator function for each player, providing the player name and optional parameters.

    +
    DATABASE:ForEachPlayerAlive(IteratorFunction, ...) +

    Iterate the DATABASE and call an iterator function for each alive player, providing the Unit of the player and optional parameters.

    +
    DATABASE:ForEachUnit(IteratorFunction, ...) +

    Iterate the DATABASE and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.
    DATABASE.PlayersDATABASE.PLAYERS
    DATABASE.PlayersAlive - -
    DATABASE:ScanEnvironment()DATABASE.PLAYERSALIVE DATABASE:Spawn(SpawnTemplate)

    Instantiate new Groups within the DCSRTE.

    -
    DATABASE.Statics -
    DATABASE.Templates -
    DATABASE:TraceDatabase() -

    Traces the current database contents in the log ...
    DATABASE:_EventOnPlayerLeaveUnit(Event)

    Handles the OnPlayerLeaveUnit event to clean the active players table.

    -
    DATABASE:_IsAliveDCSGroup(DCSGroup) - -
    DATABASE:_IsAliveDCSUnit(DCSUnit) - -
    DATABASE:_IsIncludeDCSUnit(DCSUnit) -
    DATABASE:_RegisterGroup(GroupTemplate)DATABASE:_RegisterPlayers() +

    Private method that registers all alive players in the mission.

    +
    DATABASE:_RegisterTemplate(GroupTemplate)

    Private method that registers new Group Templates within the DATABASE Object.
    DATABASE:_RegisterPlayers()DATABASE:_RegisterTemplates() -

    Private method that registers all alive players in the mission.

    +
    @@ -473,6 +431,32 @@ The following iterator methods are currently available within the DATABASE:

    + +DATABASE:AddPlayer(UnitName, PlayerName) + +
    +
    + +

    Adds a player based on the Player Name in the DATABASE.

    + +

    Parameters

    +
      +
    • + +

      UnitName :

      + +
      • +
    • + +

      PlayerName :

      + +
      • +
    +
    +
    +
    +
    + DATABASE:AddUnit(DCSUnit, DCSUnitName) @@ -513,9 +497,9 @@ The following iterator methods are currently available within the DATABASE:

    - #string - -DATABASE.ClassName + + +DATABASE.CLIENTSALIVE
    @@ -527,9 +511,9 @@ The following iterator methods are currently available within the DATABASE:

    - - -DATABASE.ClientsAlive + #string + +DATABASE.ClassName
    @@ -564,6 +548,27 @@ The following iterator methods are currently available within the DATABASE:

    +
    +
    +
    +
    + + +DATABASE:DeletePlayer(PlayerName) + +
    +
    + +

    Deletes a player from the DATABASE based on the Player Name.

    + +

    Parameter

    +
      +
    • + +

      PlayerName :

      + +
      • +
    @@ -585,34 +590,6 @@ The following iterator methods are currently available within the DATABASE:

    -
    -
    -
    -
    - - - -DATABASE.Filter - -
    -
    - - - -
    -
    -
    -
    - - - -DATABASE.FilterMeta - -
    -
    - - -
    @@ -702,7 +679,7 @@ The found Unit.

    -

    Interate the DATABASE and call an interator function for the given set, providing the Object for each element within the set and optional parameters.

    +

    Iterate the DATABASE and call an iterator function for the given set, providing the Object for each element within the set and optional parameters.

    Parameters

      @@ -739,7 +716,7 @@ self

    -

    Interate the DATABASE and call an interator function for each client, providing the Client to the function and optional parameters.

    +

    Iterate the DATABASE and call an iterator function for each CLIENT, providing the CLIENT to the function and optional parameters.

    Parameters

      @@ -765,20 +742,84 @@ self

      - -DATABASE:ForEachDCSUnit(IteratorFunction, ...) + +DATABASE:ForEachClientAlive(IteratorFunction, ...)
      -

      Interate the DATABASE and call an interator function for each alive unit, providing the Unit and optional parameters.

      +

      Iterate the DATABASE and call an iterator function for each ALIVE CLIENT, providing the CLIENT to the function and optional parameters.

      Parameters

      • #function IteratorFunction : -The function that will be called when there is an alive unit in the database. The function needs to accept a UNIT parameter.

        +The function that will be called when there is an alive CLIENT in the database. The function needs to accept a CLIENT parameter.

        + +
        • +
      • + +

        ... :

        + +
        • +
      +

      Return value

      + +

      #DATABASE: +self

      + +
      +
      +
      +
      + + +DATABASE:ForEachDCSUnit(IteratorFunction, ...) + +
      +
      + +

      Iterate the DATABASE and call an iterator function for each alive unit, providing the DCSUnit and optional parameters.

      + +

      Parameters

      +
        +
      • + +

        #function IteratorFunction : +The function that will be called when there is an alive unit in the database. The function needs to accept a DCSUnit parameter.

        + +
        • +
      • + +

        ... :

        + +
        • +
      +

      Return value

      + +

      #DATABASE: +self

      + +
      +
      +
      +
      + + +DATABASE:ForEachGroup(IteratorFunction, ...) + +
      +
      + +

      Iterate the DATABASE and call an iterator function for each alive GROUP, providing the GROUP and optional parameters.

      + +

      Parameters

      +
        +
      • + +

        #function IteratorFunction : +The function that will be called when there is an alive GROUP in the database. The function needs to accept a GROUP parameter.

      • @@ -803,7 +844,39 @@ self

        -

        Interate the DATABASE and call an interator function for each alive player, providing the Unit of the player and optional parameters.

        +

        Iterate the DATABASE and call an iterator function for each player, providing the player name and optional parameters.

        + +

        Parameters

        +
          +
        • + +

          #function IteratorFunction : +The function that will be called when there is an player in the database. The function needs to accept the player name.

          + +
          • +
        • + +

          ... :

          + +
          • +
        +

        Return value

        + +

        #DATABASE: +self

        + +
        +
      +
      +
      + + +DATABASE:ForEachPlayerAlive(IteratorFunction, ...) + +
      +
      + +

      Iterate the DATABASE and call an iterator function for each alive player, providing the Unit of the player and optional parameters.

      Parameters

        @@ -824,6 +897,38 @@ The function that will be called when there is an alive player in the database.

        #DATABASE: self

        +
      +
      +
      +
      + + +DATABASE:ForEachUnit(IteratorFunction, ...) + +
      +
      + +

      Iterate the DATABASE and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.

      + +

      Parameters

      +
        +
      • + +

        #function IteratorFunction : +The function that will be called when there is an alive UNIT in the database. The function needs to accept a UNIT parameter.

        + +
        • +
      • + +

        ... :

        + +
        • +
      +

      Return value

      + +

      #DATABASE: +self

      +
      @@ -901,8 +1006,8 @@ DBObject = DATABASE:New()
      - -DATABASE.Players + +DATABASE.PLAYERS
      @@ -915,21 +1020,8 @@ DBObject = DATABASE:New()
      - -DATABASE.PlayersAlive - -
      -
      - - - -
      -
      -
      -
      - - -DATABASE:ScanEnvironment() + +DATABASE.PLAYERSALIVE
      @@ -993,20 +1085,6 @@ This method is used by the SPAWN class.

      #DATABASE: self

      -
      -
      -
      -
      - - - -DATABASE.Statics - -
      -
      - - -
      @@ -1021,27 +1099,6 @@ self

      -
    -
    -
    -
    - - -DATABASE:TraceDatabase() - -
    -
    - -

    Traces the current database contents in the log ...

    - - -

    (for debug reasons).

    - -

    Return value

    - -

    #DATABASE: -self

    -
    @@ -1145,84 +1202,6 @@ self

    - -DATABASE:_IsAliveDCSGroup(DCSGroup) - -
    -
    - - - -

    Parameter

    - -

    Return value

    - -

    #DATABASE: -self

    - -
    -
    -
    -
    - - -DATABASE:_IsAliveDCSUnit(DCSUnit) - -
    -
    - - - -

    Parameter

    - -

    Return value

    - -

    #DATABASE: -self

    - -
    -
    -
    -
    - - -DATABASE:_IsIncludeDCSUnit(DCSUnit) - -
    -
    - - - -

    Parameter

    - -

    Return value

    - -

    #DATABASE: -self

    - -
    -
    -
    -
    - DATABASE:_RegisterDatabase() @@ -1241,32 +1220,6 @@ self

    - -DATABASE:_RegisterGroup(GroupTemplate) - -
    -
    - -

    Private method that registers new Group Templates within the DATABASE Object.

    - -

    Parameter

    -
      -
    • - -

      #table GroupTemplate :

      - -
      • -
    -

    Return value

    - -

    #DATABASE: -self

    - -
    -
    -
    -
    - DATABASE:_RegisterPlayers() @@ -1280,6 +1233,45 @@ self

    #DATABASE: self

    +
    + +
    +
    + + +DATABASE:_RegisterTemplate(GroupTemplate) + +
    +
    + +

    Private method that registers new Group Templates within the DATABASE Object.

    + +

    Parameter

    + +

    Return value

    + +

    #DATABASE: +self

    + +
    +
    +
    +
    + + +DATABASE:_RegisterTemplates() + +
    +
    + + +
    diff --git a/Moose Training/Documentation/Escort.html b/Moose Training/Documentation/Escort.html index 6da80cd1e..040d46ca3 100644 --- a/Moose Training/Documentation/Escort.html +++ b/Moose Training/Documentation/Escort.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -1859,6 +1861,9 @@ self

    + +

    self.ReportTargetsScheduler = routines.scheduleFunction( self._ReportTargetsScheduler, { self }, timer.getTime() + 1, Seconds )

    +
    diff --git a/Moose Training/Documentation/Event.html b/Moose Training/Documentation/Event.html index 153c8cb07..1591464a5 100644 --- a/Moose Training/Documentation/Event.html +++ b/Moose Training/Documentation/Event.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/GOHOMETASK.html b/Moose Training/Documentation/GOHOMETASK.html index 3a3adccd4..be69f3990 100644 --- a/Moose Training/Documentation/GOHOMETASK.html +++ b/Moose Training/Documentation/GOHOMETASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/Group.html b/Moose Training/Documentation/Group.html index cfbc60f20..4e957bb03 100644 --- a/Moose Training/Documentation/Group.html +++ b/Moose Training/Documentation/Group.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -212,6 +214,12 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return GROUP:GetCoalition()

    Returns the coalition of the DCS Group.

    + + + + GROUP:GetCountry() + +

    Returns the country of the DCS Group.

    @@ -1068,6 +1076,34 @@ The coalition side of the DCS Group.

    + +GROUP:GetCountry() + +
    +
    + +

    Returns the country of the DCS Group.

    + +

    Return values

    +
      +
    1. + +

      DCScountry#country.id: +The country identifier.

      + +
      2. +
    2. + +

      #nil: +The DCS Group is not existing or alive.

      + +
      3. +
    +
    +
    +
    +
    + GROUP:GetDCSGroup() diff --git a/Moose Training/Documentation/GroupSet.html b/Moose Training/Documentation/GroupSet.html new file mode 100644 index 000000000..140e7e19a --- /dev/null +++ b/Moose Training/Documentation/GroupSet.html @@ -0,0 +1,644 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module GroupSet

    + +

    Create and manage a set of groups.

    + + + +

    #GROUPSET class

    +

    Mission designers can use the GROUPSET class to build sets of groups belonging to certain:

    + +
      +
    • Coalitions
      • +
    • Categories
      • +
    • Countries
      • +
    • Starting with certain prefix strings.
      • +
    + +

    GROUPSET construction methods:

    +

    Create a new GROUPSET object with the GROUPSET.New method:

    + + + + +

    GROUPSET filter criteria:

    +

    You can set filter criteria to define the set of groups within the GROUPSET. +Filter criteria are defined by:

    + + + +

    Once the filter criteria have been set for the GROUPSET, you can start filtering using:

    + + + +

    Planned filter criteria within development are (so these are not yet available):

    + + + + +

    GROUPSET iterators:

    +

    Once the filters have been defined and the GROUPSET has been built, you can iterate the GROUPSET with the available iterator methods. +The iterator methods will walk the GROUPSET set, and call for each element within the set a function that you provide. +The following iterator methods are currently available within the GROUPSET:

    + + + +

    Planned iterators methods in development are (so these are not yet available):

    + + + + +

    Global(s)

    + + + + + +
    GROUPSET + +
    +

    Type GROUPSET

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    GROUPSET:AddInDatabase(Event) +

    Handles the Database to check on an event (birth) that the Object was added in the Database.

    +
    GROUPSET.ClassName + +
    GROUPSET.Filter + +
    GROUPSET:FilterCategories(Categories) +

    Builds a set of groups out of categories.

    +
    GROUPSET:FilterCoalitions(Coalitions) +

    Builds a set of groups of coalitions.

    +
    GROUPSET:FilterCountries(Countries) +

    Builds a set of groups of defined countries.

    +
    GROUPSET.FilterMeta + +
    GROUPSET:FilterPrefixes(Prefixes) +

    Builds a set of groups of defined unit prefixes.

    +
    GROUPSET:FilterStart() +

    Starts the filtering.

    +
    GROUPSET:FindInDatabase(Event) +

    Handles the Database to check on any event that Object exists in the Database.

    +
    GROUPSET:FindUnit(GroupName) +

    Finds a Unit based on the Unit Name.

    +
    GROUPSET:ForEachUnit(IteratorFunction, ...) +

    Interate the GROUPSET and call an interator function for each alive GROUP, providing the GROUP and optional parameters.

    +
    GROUPSET:IsIncludeObject(MooseGroup) + +
    GROUPSET:New() +

    Creates a new GROUPSET object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.

    +
    GROUPSET.Units + +
    + +

    Global(s)

    +
    +
    + + #GROUPSET + +GROUPSET + +
    +
    + + + +
    +
    +

    Type GroupSet

    + +

    Type GROUPSET

    + +

    GROUPSET class

    + +

    Field(s)

    +
    +
    + + +GROUPSET:AddInDatabase(Event) + +
    +
    + +

    Handles the Database to check on an event (birth) that the Object was added in the Database.

    + + +

    This is required, because sometimes the _DATABASE birth event gets called later than the SET birth event!

    + +

    Parameter

    + +

    Return values

    +
      +
    1. + +

      #string: +The name of the GROUP

      + +
      2. +
    2. + +

      #table: +The GROUP

      + +
      3. +
    +
    +
    +
    +
    + + #string + +GROUPSET.ClassName + +
    +
    + + + +
    +
    +
    +
    + + + +GROUPSET.Filter + +
    +
    + + + +
    +
    +
    +
    + + +GROUPSET:FilterCategories(Categories) + +
    +
    + +

    Builds a set of groups out of categories.

    + + +

    Possible current categories are plane, helicopter, ground, ship.

    + +

    Parameter

    +
      +
    • + +

      #string Categories : +Can take the following values: "plane", "helicopter", "ground", "ship".

      + +
      • +
    +

    Return value

    + +

    #GROUPSET: +self

    + +
    +
    +
    +
    + + +GROUPSET:FilterCoalitions(Coalitions) + +
    +
    + +

    Builds a set of groups of coalitions.

    + + +

    Possible current coalitions are red, blue and neutral.

    + +

    Parameter

    +
      +
    • + +

      #string Coalitions : +Can take the following values: "red", "blue", "neutral".

      + +
      • +
    +

    Return value

    + +

    #GROUPSET: +self

    + +
    +
    +
    +
    + + +GROUPSET:FilterCountries(Countries) + +
    +
    + +

    Builds a set of groups of defined countries.

    + + +

    Possible current countries are those known within DCS world.

    + +

    Parameter

    +
      +
    • + +

      #string Countries : +Can take those country strings known within DCS world.

      + +
      • +
    +

    Return value

    + +

    #GROUPSET: +self

    + +
    +
    +
    +
    + + + +GROUPSET.FilterMeta + +
    +
    + + + +
    +
    +
    +
    + + +GROUPSET:FilterPrefixes(Prefixes) + +
    +
    + +

    Builds a set of groups of defined unit prefixes.

    + + +

    All the groups starting with the given prefixes will be included within the set.

    + +

    Parameter

    +
      +
    • + +

      #string Prefixes : +The prefix of which the group name starts with.

      + +
      • +
    +

    Return value

    + +

    #GROUPSET: +self

    + +
    +
    +
    +
    + + +GROUPSET:FilterStart() + +
    +
    + +

    Starts the filtering.

    + +

    Return value

    + +

    #GROUPSET: +self

    + +
    +
    +
    +
    + + +GROUPSET:FindInDatabase(Event) + +
    +
    + +

    Handles the Database to check on any event that Object exists in the Database.

    + + +

    This is required, because sometimes the _DATABASE event gets called later than the SET event or vise versa!

    + +

    Parameter

    + +

    Return values

    +
      +
    1. + +

      #string: +The name of the GROUP

      + +
      2. +
    2. + +

      #table: +The GROUP

      + +
      3. +
    +
    +
    +
    +
    + + +GROUPSET:FindUnit(GroupName) + +
    +
    + +

    Finds a Unit based on the Unit Name.

    + +

    Parameter

    +
      +
    • + +

      #string GroupName :

      + +
      • +
    +

    Return value

    + +

    Group#GROUP: +The found Unit.

    + +
    +
    +
    +
    + + +GROUPSET:ForEachUnit(IteratorFunction, ...) + +
    +
    + +

    Interate the GROUPSET and call an interator function for each alive GROUP, providing the GROUP and optional parameters.

    + +

    Parameters

    +
      +
    • + +

      #function IteratorFunction : +The function that will be called when there is an alive GROUP in the GROUPSET. The function needs to accept a GROUP parameter.

      + +
      • +
    • + +

      ... :

      + +
      • +
    +

    Return value

    + +

    #GROUPSET: +self

    + +
    +
    +
    +
    + + +GROUPSET:IsIncludeObject(MooseGroup) + +
    +
    + + + +

    Parameter

    + +

    Return value

    + +

    #GROUPSET: +self

    + +
    +
    +
    +
    + + +GROUPSET:New() + +
    +
    + +

    Creates a new GROUPSET object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.

    + +

    Return value

    + +

    #GROUPSET:

    + + +

    Usage:

    + 
    -- Define a new GROUPSET Object. This DBObject will contain a reference to all alive GROUPS.
+DBObject = GROUPSET:New()
    + +
    +
    +
    +
    + + + +GROUPSET.Units + +
    +
    + + + +
    +
    + +
    + +
    + + diff --git a/Moose Training/Documentation/MISSION.html b/Moose Training/Documentation/MISSION.html index 0e909bbc5..785f9854a 100644 --- a/Moose Training/Documentation/MISSION.html +++ b/Moose Training/Documentation/MISSION.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -66,7 +68,7 @@
    -

    Module MISSION

    +

    Module Mission

    A MISSION is the main owner of a Mission orchestration within MOOSE .

    @@ -86,12 +88,6 @@ A CLIENT needs to be registered within the MISSIONSCHEDULER - - - - TaskComplete - - @@ -101,8 +97,8 @@ A CLIENT needs to be registered within the Type MISSION - +

    Type MISSION

    +
    + + + + @@ -466,24 +468,6 @@ A CLIENT needs to be registered within the -
    - - #boolean - -TaskComplete - -
    -
    - - - - -

    For each Client, check for each Task the state and evolve the mission. - This flag will indicate if the Task of the Client is Complete.

    -
    @@ -511,8 +495,13 @@ A CLIENT needs to be registered within the Type MISSION -

    Field(s)

    +

    Type Mission

    + +

    Type MISSION

    + +

    The MISSION class

    + +

    Field(s)

    @@ -550,10 +539,10 @@ Client is the CLIENT object. The object must have been

    Usage:

    Add a number of Client objects to the Mission.
-	Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 1', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
-	Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 3', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
-	Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 2', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
-	Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 4', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
    + Mission:AddClient( CLIENT:FindByName( 'US UH-1H*HOT-Deploy Troops 1', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() ) + Mission:AddClient( CLIENT:FindByName( 'US UH-1H*RAMP-Deploy Troops 3', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() ) + Mission:AddClient( CLIENT:FindByName( 'US UH-1H*HOT-Deploy Troops 2', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() ) + Mission:AddClient( CLIENT:FindByName( 'US UH-1H*RAMP-Deploy Troops 4', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
    @@ -885,6 +874,20 @@ env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" ) + +
    +
    +
    + + #string + +MISSION.MissionBriefing + +
    +
    + + +
    @@ -1197,7 +1200,7 @@ local Mission = MISSIONSCHEDULER.AddMission( 'Rescue secret agent', 'Tactical',
    - + #MISSION.Clients MISSION._Clients @@ -1237,6 +1240,8 @@ local Mission = MISSIONSCHEDULER.AddMission( 'Rescue secret agent', 'Tactical',
    +

    Type MISSION.Clients

    +

    Type MISSIONSCHEDULER

    The MISSIONSCHEDULER is an OBJECT and is the main scheduler of ALL active MISSIONs registered within this scheduler.

    @@ -1339,7 +1344,7 @@ MissionFind = MISSIONSCHEDULER:FindMission( 'Russia Transport Troops SA-6' )
    - + #MISSIONSCHEDULER.MISSIONS MISSIONSCHEDULER.Missions @@ -1491,6 +1496,9 @@ MISSIONSCHEDULER:RemoveMission( 'Russia Transport Troops SA-6' ) + +

    MISSIONSCHEDULER.SchedulerId = routines.scheduleFunction( MISSIONSCHEDULER.Scheduler, { }, 0, 2 )

    +
    @@ -1628,6 +1636,8 @@ MISSIONSCHEDULER:RemoveMission( 'Russia Transport Troops SA-6' )
    +

    Type MISSIONSCHEDULER.MISSIONS

    + diff --git a/Moose Training/Documentation/MOVEMENT.html b/Moose Training/Documentation/MOVEMENT.html index 5d35d954c..ef93fb7c1 100644 --- a/Moose Training/Documentation/MOVEMENT.html +++ b/Moose Training/Documentation/MOVEMENT.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/Menu.html b/Moose Training/Documentation/Menu.html index 286cd3f1f..7086e16b5 100644 --- a/Moose Training/Documentation/Menu.html +++ b/Moose Training/Documentation/Menu.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/Message.html b/Moose Training/Documentation/Message.html index e7fb13b06..5b3fd432f 100644 --- a/Moose Training/Documentation/Message.html +++ b/Moose Training/Documentation/Message.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/MissileTrainer.html b/Moose Training/Documentation/MissileTrainer.html index 8e21f7b5b..10678955f 100644 --- a/Moose Training/Documentation/MissileTrainer.html +++ b/Moose Training/Documentation/MissileTrainer.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/NOTASK.html b/Moose Training/Documentation/NOTASK.html index 8aeb474b4..66d88c1ba 100644 --- a/Moose Training/Documentation/NOTASK.html +++ b/Moose Training/Documentation/NOTASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/PICKUPTASK.html b/Moose Training/Documentation/PICKUPTASK.html index 079600693..50e1e220d 100644 --- a/Moose Training/Documentation/PICKUPTASK.html +++ b/Moose Training/Documentation/PICKUPTASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/ROUTETASK.html b/Moose Training/Documentation/ROUTETASK.html index b53f143b3..efd64169e 100644 --- a/Moose Training/Documentation/ROUTETASK.html +++ b/Moose Training/Documentation/ROUTETASK.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/STAGE.html b/Moose Training/Documentation/STAGE.html index c45a68326..a4476cf94 100644 --- a/Moose Training/Documentation/STAGE.html +++ b/Moose Training/Documentation/STAGE.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -274,6 +276,16 @@ + +
    MISSION.AddClient(CLIENT, self, Client) @@ -197,6 +193,12 @@ A CLIENT needs to be registered within the MISSION:Meta() +
    MISSION.MissionBriefing +
    STAGE.WaitTime +
    + +

    Type STAGEBRIEF

    + + + +
    STAGEBRIEF.StageBriefingTime +
    @@ -809,6 +821,23 @@

    Type STAGEARRIVE

    +

    Type STAGEBRIEF

    +

    Field(s)

    +
    +
    + + + +STAGEBRIEF.StageBriefingTime + +
    +
    + + + +
    +
    +

    Type STAGELANDING

    Type STAGEROUTE

    diff --git a/Moose Training/Documentation/Scheduler.html b/Moose Training/Documentation/Scheduler.html index 0b09abf54..59557d5cf 100644 --- a/Moose Training/Documentation/Scheduler.html +++ b/Moose Training/Documentation/Scheduler.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -91,8 +93,6 @@ - -

    Global(s)

    @@ -120,12 +120,6 @@ - - - - @@ -138,6 +132,12 @@ + + + +
    SCHEDULER.Repeat -
    SCHEDULER:Scheduler() -
    SCHEDULER:Stop()

    Stops the scheduler.

    +
    SCHEDULER:_Scheduler() +
    @@ -253,19 +253,6 @@ self

    - -
    -
    -
    - - -SCHEDULER:Scheduler() - -
    -
    - - -
    @@ -302,6 +289,19 @@ self

    #SCHEDULER: self

    + +
    +
    +
    + + +SCHEDULER:_Scheduler() + +
    +
    + + +
    diff --git a/Moose Training/Documentation/Scoring.html b/Moose Training/Documentation/Scoring.html index bcecc4626..199f2d13d 100644 --- a/Moose Training/Documentation/Scoring.html +++ b/Moose Training/Documentation/Scoring.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/Sead.html b/Moose Training/Documentation/Sead.html index e8bf12d86..68a532b60 100644 --- a/Moose Training/Documentation/Sead.html +++ b/Moose Training/Documentation/Sead.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • diff --git a/Moose Training/Documentation/Set.html b/Moose Training/Documentation/Set.html index e43329a31..5d11030b7 100644 --- a/Moose Training/Documentation/Set.html +++ b/Moose Training/Documentation/Set.html @@ -42,11 +42,12 @@
  • Event
  • GOHOMETASK
  • Group
    • -
  • MISSION
    • +
  • GroupSet
  • MOVEMENT
  • Menu
  • Message
  • MissileTrainer
    • +
  • Mission
  • NOTASK
  • PICKUPTASK
  • ROUTETASK
    • @@ -59,6 +60,7 @@
  • StaticObject
  • TASK
  • Unit
    • +
  • UnitSet
  • Zone
  • env
  • land
    • @@ -154,111 +156,21 @@ The following iterator methods are currently available within the SET:

    Type SET

    - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -268,99 +180,33 @@ The following iterator methods are currently available within the SET:

    - + - - - - - - - - - - - - - - - - - - - - - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - @@ -370,45 +216,15 @@ The following iterator methods are currently available within the SET:

    - + - + - - - - - - - - - - - - - - - - - - - -
    SET:AddUnit(UnitToAdd) -

    Finds a Unit based on the Unit Name.

    -
    SET.ClassName
    SET.ClientsSET.Database
    SET.ClientsAliveSET:Flush() - -
    SET.DCSGroups - -
    SET.DCSGroupsAlive - -
    SET.DCSUnits - -
    SET.DCSUnitsAlive - -
    SET.Filter - -
    SET:FilterCategories(Categories) -

    Builds a set of units out of categories.

    -
    SET:FilterCoalitions(Coalitions) -

    Builds a set of units of coalitons.

    -
    SET:FilterCountries(Countries) -

    Builds a set of units of defined countries.

    -
    SET:FilterGroupPrefixes(Prefixes) -

    Builds a set of units of defined group prefixes.

    -
    SET.FilterMeta - -
    SET:FilterStart() -

    Starts the filtering.

    -
    SET:FilterTypes(Types) -

    Builds a set of units of defined unit types.

    -
    SET:FilterUnitPrefixes(Prefixes) -

    Builds a set of units of defined unit prefixes.

    -
    SET:FindUnit(UnitName) -

    Finds a Unit based on the Unit Name.

    +

    Flushes the current SET contents in the log ...
    SET:ForEachClient(IteratorFunction, ...)SET:IsIncludeObject(Object) -

    Interate the SET and call an interator function for each client, providing the Client to the function and optional parameters.

    +

    Decides whether to include the Object
    SET:ForEachDCSUnitAlive(IteratorFunction, ...) -

    Interate the SET and call an interator function for each alive unit, providing the Unit and optional parameters.

    -
    SET:ForEachPlayer(IteratorFunction, ...) -

    Interate the SET and call an interator function for each alive player, providing the Unit of the player and optional parameters.

    -
    SET.Groups - -
    SET.GroupsAlive - -
    SET.NavPoints - -
    SET:New()SET:New(Database)

    Creates a new SET object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.
    SET.PlayersSET.Set
    SET.PlayersAliveSET:_Add(ObjectName, Object) - -
    SET:ScanEnvironment() - -
    SET.Statics - -
    SET.Templates - -
    SET:TraceDatabase() -

    Traces the current SET contents in the log ...

    -
    SET.Units - -
    SET.UnitsAlive - +

    Adds a Object based on the Object Name.
    SET:_EventOnBirth(Event) -

    Handles the OnBirth event for the alive units set.

    +

    Handles the OnBirth event for the Set.
    SET:_EventOnPlayerEnterUnit(Event)SET:_FilterStart() -

    Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).

    +

    Starts the filtering for the defined collection.
    SET:_EventOnPlayerLeaveUnit(Event)SET:_Find(ObjectName) -

    Handles the OnPlayerLeaveUnit event to clean the active players table.

    -
    SET:_IsAliveDCSGroup(DCSGroup) - -
    SET:_IsAliveDCSUnit(DCSUnit) - -
    SET:_IsIncludeDCSUnit(DCSUnit) - -
    SET:_RegisterDatabase() -

    Private method that registers all datapoints within in the mission.

    -
    SET:_RegisterPlayers() -

    Private method that registers all alive players in the mission.

    +

    Finds an Object based on the Object Name.
    @@ -438,32 +254,6 @@ The following iterator methods are currently available within the SET:

    - -SET:AddUnit(UnitToAdd) - -
    -
    - -

    Finds a Unit based on the Unit Name.

    - -

    Parameter

    - -

    Return value

    - -

    Unit#UNIT: -The added Unit.

    - -
    -
    -
    -
    - #string SET.ClassName @@ -479,8 +269,8 @@ The added Unit.

    - -SET.Clients + +SET.Database
    @@ -492,322 +282,21 @@ The added Unit.

    - - -SET.ClientsAlive + +SET:Flush()
    - - -
    -
    -
    -
    - - - -SET.DCSGroups - -
    -
    - - - -
    -
    -
    -
    - - - -SET.DCSGroupsAlive - -
    -
    - - - -
    -
    -
    -
    - - - -SET.DCSUnits - -
    -
    - - - -
    -
    -
    -
    - - - -SET.DCSUnitsAlive - -
    -
    - - - -
    -
    -
    -
    - - - -SET.Filter - -
    -
    - - - -
    -
    -
    -
    - - -SET:FilterCategories(Categories) - -
    -
    - -

    Builds a set of units out of categories.

    +

    Flushes the current SET contents in the log ...

    -

    Possible current categories are plane, helicopter, ground, ship.

    - -

    Parameter

    -
      -
    • - -

      #string Categories : -Can take the following values: "plane", "helicopter", "ground", "ship".

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - -SET:FilterCoalitions(Coalitions) - -
    -
    - -

    Builds a set of units of coalitons.

    - - -

    Possible current coalitions are red, blue and neutral.

    - -

    Parameter

    -
      -
    • - -

      #string Coalitions : -Can take the following values: "red", "blue", "neutral".

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - -SET:FilterCountries(Countries) - -
    -
    - -

    Builds a set of units of defined countries.

    - - -

    Possible current countries are those known within DCS world.

    - -

    Parameter

    -
      -
    • - -

      #string Countries : -Can take those country strings known within DCS world.

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - -SET:FilterGroupPrefixes(Prefixes) - -
    -
    - -

    Builds a set of units of defined group prefixes.

    - - -

    All the units starting with the given group prefixes will be included within the set.

    - -

    Parameter

    -
      -
    • - -

      #string Prefixes : -The prefix of which the group name where the unit belongs to starts with.

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - - -SET.FilterMeta - -
    -
    - - - -
    -
    -
    -
    - - -SET:FilterStart() - -
    -
    - -

    Starts the filtering.

    +

    (for debug reasons).

    Return value

    -

    #SET: -self

    - -
    -
    -
    -
    - - -SET:FilterTypes(Types) - -
    -
    - -

    Builds a set of units of defined unit types.

    - - -

    Possible current types are those types known within DCS world.

    - -

    Parameter

    -
      -
    • - -

      #string Types : -Can take those type strings known within DCS world.

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - -SET:FilterUnitPrefixes(Prefixes) - -
    -
    - -

    Builds a set of units of defined unit prefixes.

    - - -

    All the units starting with the given prefixes will be included within the set.

    - -

    Parameter

    -
      -
    • - -

      #string Prefixes : -The prefix of which the unit name starts with.

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - -SET:FindUnit(UnitName) - -
    -
    - -

    Finds a Unit based on the Unit Name.

    - -

    Parameter

    -
      -
    • - -

      #string UnitName :

      - -
      • -
    -

    Return value

    - -

    Unit#UNIT: -The found Unit.

    +

    #string: +A string with the names of the objects.

    @@ -851,25 +340,19 @@ self

    - -SET:ForEachClient(IteratorFunction, ...) + +SET:IsIncludeObject(Object)
    -

    Interate the SET and call an interator function for each client, providing the Client to the function and optional parameters.

    +

    Decides whether to include the Object

    -

    Parameters

    +

    Parameter

    • -

      #function IteratorFunction : -The function that will be called when there is an alive player in the SET. The function needs to accept a CLIENT parameter.

      - -
      • -
    • - -

      ... :

      +

      #table Object :

    @@ -878,125 +361,27 @@ The function that will be called when there is an alive player in the SET. The f

    #SET: self

    -
    -
    -
    -
    - - -SET:ForEachDCSUnitAlive(IteratorFunction, ...) - -
    -
    - -

    Interate the SET and call an interator function for each alive unit, providing the Unit and optional parameters.

    - -

    Parameters

    -
      -
    • - -

      #function IteratorFunction : -The function that will be called when there is an alive unit in the SET. The function needs to accept a UNIT parameter.

      - -
      • -
    • - -

      ... :

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - -SET:ForEachPlayer(IteratorFunction, ...) - -
    -
    - -

    Interate the SET and call an interator function for each alive player, providing the Unit of the player and optional parameters.

    - -

    Parameters

    -
      -
    • - -

      #function IteratorFunction : -The function that will be called when there is an alive player in the SET. The function needs to accept a UNIT parameter.

      - -
      • -
    • - -

      ... :

      - -
      • -
    -

    Return value

    - -

    #SET: -self

    - -
    -
    -
    -
    - - - -SET.Groups - -
    -
    - - - -
    -
    -
    -
    - - - -SET.GroupsAlive - -
    -
    - - - -
    -
    -
    -
    - - - -SET.NavPoints - -
    -
    - - -
    -SET:New() +SET:New(Database)

    Creates a new SET object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.

    +

    Parameter

    +
      +
    • + +

      Database :

      + +
      • +

    Return value

    #SET:

    @@ -1012,8 +397,8 @@ DBObject = SET:New()
    - -SET.Players + +SET.Set
    @@ -1025,104 +410,31 @@ DBObject = SET:New()
    - - -SET.PlayersAlive + +SET:_Add(ObjectName, Object)
    +

    Adds a Object based on the Object Name.

    +

    Parameters

    +
      +
    • + +

      #string ObjectName :

      -
    -
    -
    -
    - - -SET:ScanEnvironment() - -
    -
    - - - -
    -
    -
    -
    - - - -SET.Statics - -
    -
    - - - -
    -
    -
    -
    - - - -SET.Templates - -
    -
    - - - -
    -
    -
    -
    - - -SET:TraceDatabase() - -
    -
    - -

    Traces the current SET contents in the log ...

    - - -

    (for debug reasons).

    + +
  • + +

    #table Object :

    +
    • +

    Return value

    -

    #SET: -self

    - -
    -
    -
    -
    - - - -SET.Units - -
    -
    - - - -
    -
    -
    -
    - - - -SET.UnitsAlive - -
    -
    - - +

    #table: +The added Object.

    @@ -1135,7 +447,7 @@ self

    -

    Handles the OnBirth event for the alive units set.

    +

    Handles the OnBirth event for the Set.

    Parameter