From 291c4e5ba91db982b86646d35646f6d85501fa7e Mon Sep 17 00:00:00 2001 From: FlightControl Date: Sat, 30 Apr 2016 07:42:53 +0200 Subject: [PATCH] Database and Documentation --- Documentation/Base.html | 2 +- Documentation/CARGO.html | 2 +- Documentation/CLEANUP.html | 2 +- Documentation/Client.html | 2 +- Documentation/DCSAirbase.html | 2 +- Documentation/DCSCoalitionObject.html | 2 +- Documentation/DCSCommand.html | 2 +- Documentation/DCSController.html | 2 +- Documentation/DCSGroup.html | 2 +- Documentation/DCSObject.html | 2 +- Documentation/DCSTask.html | 2 +- Documentation/DCSTypes.html | 2 +- Documentation/DCSUnit.html | 2 +- Documentation/DCSWorld.html | 2 +- Documentation/DCStimer.html | 2 +- Documentation/DEPLOYTASK.html | 2 +- Documentation/DESTROYBASETASK.html | 2 +- Documentation/DESTROYGROUPSTASK.html | 2 +- Documentation/DESTROYRADARSTASK.html | 2 +- Documentation/DESTROYUNITTYPESTASK.html | 2 +- Documentation/Database.html | 177 ++++++++++++------------ Documentation/Escort.html | 3 +- Documentation/Event.html | 2 +- Documentation/GOHOMETASK.html | 2 +- Documentation/Group.html | 2 +- Documentation/MISSION.html | 2 +- Documentation/MOVEMENT.html | 2 +- Documentation/Menu.html | 2 +- Documentation/Message.html | 2 +- Documentation/NOTASK.html | 2 +- Documentation/PICKUPTASK.html | 2 +- Documentation/ROUTETASK.html | 2 +- Documentation/STAGE.html | 2 +- Documentation/Scoring.html | 2 +- Documentation/Sead.html | 2 +- Documentation/Spawn.html | 2 +- Documentation/StaticObject.html | 2 +- Documentation/TASK.html | 2 +- Documentation/Unit.html | 2 +- Documentation/Zone.html | 2 +- Documentation/env.html | 2 +- Documentation/index.html | 14 +- Documentation/land.html | 2 +- Documentation/routines.html | 2 +- Moose/Database.lua | 41 +++--- 45 files changed, 158 insertions(+), 159 deletions(-) diff --git a/Documentation/Base.html b/Documentation/Base.html index de608bcaf..38a98cec0 100644 --- a/Documentation/Base.html +++ b/Documentation/Base.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/CARGO.html b/Documentation/CARGO.html index 30d778ea2..4af5e6241 100644 --- a/Documentation/CARGO.html +++ b/Documentation/CARGO.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/CLEANUP.html b/Documentation/CLEANUP.html index 4d2aa04a7..2e2642f68 100644 --- a/Documentation/CLEANUP.html +++ b/Documentation/CLEANUP.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Client.html b/Documentation/Client.html index 6ea751dae..84d7e426c 100644 --- a/Documentation/Client.html +++ b/Documentation/Client.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSAirbase.html b/Documentation/DCSAirbase.html index 5ba906d1e..c99bf8245 100644 --- a/Documentation/DCSAirbase.html +++ b/Documentation/DCSAirbase.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSCoalitionObject.html b/Documentation/DCSCoalitionObject.html index 8f4146e80..2bea5a1b5 100644 --- a/Documentation/DCSCoalitionObject.html +++ b/Documentation/DCSCoalitionObject.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSCommand.html b/Documentation/DCSCommand.html index e5cb77601..3150f700f 100644 --- a/Documentation/DCSCommand.html +++ b/Documentation/DCSCommand.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSController.html b/Documentation/DCSController.html index 05bd95b0e..e4cce5c0d 100644 --- a/Documentation/DCSController.html +++ b/Documentation/DCSController.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSGroup.html b/Documentation/DCSGroup.html index 9f2258624..dd7001392 100644 --- a/Documentation/DCSGroup.html +++ b/Documentation/DCSGroup.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSObject.html b/Documentation/DCSObject.html index 017a27b88..56cbb69dd 100644 --- a/Documentation/DCSObject.html +++ b/Documentation/DCSObject.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSTask.html b/Documentation/DCSTask.html index 4f42d8760..478cc51cf 100644 --- a/Documentation/DCSTask.html +++ b/Documentation/DCSTask.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSTypes.html b/Documentation/DCSTypes.html index 7eb5381e2..6d91375f4 100644 --- a/Documentation/DCSTypes.html +++ b/Documentation/DCSTypes.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSUnit.html b/Documentation/DCSUnit.html index 7b78a1fd6..11c5a3b41 100644 --- a/Documentation/DCSUnit.html +++ b/Documentation/DCSUnit.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCSWorld.html b/Documentation/DCSWorld.html index e1dc25088..0470048f3 100644 --- a/Documentation/DCSWorld.html +++ b/Documentation/DCSWorld.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DCStimer.html b/Documentation/DCStimer.html index 1ee0f7a2c..36682b66f 100644 --- a/Documentation/DCStimer.html +++ b/Documentation/DCStimer.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DEPLOYTASK.html b/Documentation/DEPLOYTASK.html index 846eb6968..1bd82e7b7 100644 --- a/Documentation/DEPLOYTASK.html +++ b/Documentation/DEPLOYTASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DESTROYBASETASK.html b/Documentation/DESTROYBASETASK.html index e239668bd..9605895ce 100644 --- a/Documentation/DESTROYBASETASK.html +++ b/Documentation/DESTROYBASETASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DESTROYGROUPSTASK.html b/Documentation/DESTROYGROUPSTASK.html index 0307805d5..0d5a3cbdb 100644 --- a/Documentation/DESTROYGROUPSTASK.html +++ b/Documentation/DESTROYGROUPSTASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DESTROYRADARSTASK.html b/Documentation/DESTROYRADARSTASK.html index 26d37714a..f7fc20204 100644 --- a/Documentation/DESTROYRADARSTASK.html +++ b/Documentation/DESTROYRADARSTASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/DESTROYUNITTYPESTASK.html b/Documentation/DESTROYUNITTYPESTASK.html index 48e9b5d50..fcbd0827c 100644 --- a/Documentation/DESTROYUNITTYPESTASK.html +++ b/Documentation/DESTROYUNITTYPESTASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Database.html b/Documentation/Database.html index cb2bdddb7..c6baf3672 100644 --- a/Documentation/Database.html +++ b/Documentation/Database.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • @@ -63,75 +63,9 @@
    -

    Module Database

    +

    Module DATABASE

    -

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

    - -

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

    - - - -

    Note that this is an initial filter set. More to follow, like zones etc.

    - - -

    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):

    - - - - -

    DATABASE iterators:

    -

    Once the filters have been defined and the DATABASE has been built, 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)

    @@ -142,8 +76,8 @@ The following iterator methods are currently available within the DATABASE:

    -

    Type DATABASE

    - +

    Type DATABASE

    +
    - + - + @@ -217,7 +151,7 @@ The following iterator methods are currently available within the DATABASE:

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

    - + - + @@ -365,11 +299,76 @@ The following iterator methods are currently available within the DATABASE:

    -

    Type Database

    +

    Type DATABASE

    + +

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

    + -

    Type DATABASE

    - -

    The DATABASE class

    +

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

    + + + +

    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 ...

    + +

    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):

    + + + + +

    DATABASE iterators:

    +

    Once the filters have been defined and the DATABASE has been built, 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):

    + + +

    Field(s)

    @@ -501,8 +500,8 @@ The following iterator methods are currently available within the DATABASE:

    - -DATABASE:FilterCategory(Categories) + +DATABASE:FilterCategories(Categories)
    @@ -531,8 +530,8 @@ self

    - -DATABASE:FilterCoalition(Coalitions) + +DATABASE:FilterCoalitions(Coalitions)
    @@ -591,8 +590,8 @@ self

    - -DATABASE:FilterGroupPrefix(Prefixes) + +DATABASE:FilterGroupPrefixes(Prefixes)
    @@ -653,8 +652,8 @@ self

    - -DATABASE:FilterType(Types) + +DATABASE:FilterTypes(Types)
    @@ -683,8 +682,8 @@ self

    - -DATABASE:FilterUnitPrefix(Prefixes) + +DATABASE:FilterUnitPrefixes(Prefixes)
    diff --git a/Documentation/Escort.html b/Documentation/Escort.html index 9855f9944..e5305361f 100644 --- a/Documentation/Escort.html +++ b/Documentation/Escort.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • @@ -1835,7 +1835,6 @@ self

    - ESCORT.ReportTargetsScheduler diff --git a/Documentation/Event.html b/Documentation/Event.html index eaa58b863..50ed86fc5 100644 --- a/Documentation/Event.html +++ b/Documentation/Event.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/GOHOMETASK.html b/Documentation/GOHOMETASK.html index b1ebecdcd..dc2a4b028 100644 --- a/Documentation/GOHOMETASK.html +++ b/Documentation/GOHOMETASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Group.html b/Documentation/Group.html index 3298e9321..c260ae21d 100644 --- a/Documentation/Group.html +++ b/Documentation/Group.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/MISSION.html b/Documentation/MISSION.html index 81752775f..f320ff531 100644 --- a/Documentation/MISSION.html +++ b/Documentation/MISSION.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/MOVEMENT.html b/Documentation/MOVEMENT.html index 1fd0bfce1..bf2539324 100644 --- a/Documentation/MOVEMENT.html +++ b/Documentation/MOVEMENT.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Menu.html b/Documentation/Menu.html index a82742975..744da29a2 100644 --- a/Documentation/Menu.html +++ b/Documentation/Menu.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Message.html b/Documentation/Message.html index 66c9d6c91..2141cc4dc 100644 --- a/Documentation/Message.html +++ b/Documentation/Message.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/NOTASK.html b/Documentation/NOTASK.html index 4fa604429..44017a343 100644 --- a/Documentation/NOTASK.html +++ b/Documentation/NOTASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/PICKUPTASK.html b/Documentation/PICKUPTASK.html index e9fcbf698..0a5e99486 100644 --- a/Documentation/PICKUPTASK.html +++ b/Documentation/PICKUPTASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/ROUTETASK.html b/Documentation/ROUTETASK.html index 87dc106be..6d7554c75 100644 --- a/Documentation/ROUTETASK.html +++ b/Documentation/ROUTETASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/STAGE.html b/Documentation/STAGE.html index bc38980e4..2e49e72dd 100644 --- a/Documentation/STAGE.html +++ b/Documentation/STAGE.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Scoring.html b/Documentation/Scoring.html index b70b673fb..4e4180ae7 100644 --- a/Documentation/Scoring.html +++ b/Documentation/Scoring.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Sead.html b/Documentation/Sead.html index 95c47ee9e..84d17c60e 100644 --- a/Documentation/Sead.html +++ b/Documentation/Sead.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Spawn.html b/Documentation/Spawn.html index 49bc1e57f..770a35c22 100644 --- a/Documentation/Spawn.html +++ b/Documentation/Spawn.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/StaticObject.html b/Documentation/StaticObject.html index 9f6847026..aa4f9fe4e 100644 --- a/Documentation/StaticObject.html +++ b/Documentation/StaticObject.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/TASK.html b/Documentation/TASK.html index bc244726c..a8215456d 100644 --- a/Documentation/TASK.html +++ b/Documentation/TASK.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Unit.html b/Documentation/Unit.html index 985e6a1e7..ed1a6112c 100644 --- a/Documentation/Unit.html +++ b/Documentation/Unit.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/Zone.html b/Documentation/Zone.html index 1b9c3cb4b..15939e2e1 100644 --- a/Documentation/Zone.html +++ b/Documentation/Zone.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/env.html b/Documentation/env.html index 959ef7350..ddd05da06 100644 --- a/Documentation/env.html +++ b/Documentation/env.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/index.html b/Documentation/index.html index 50958b731..d6bdc643a 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • @@ -87,6 +87,12 @@
    + + + + @@ -183,12 +189,6 @@ - - - - diff --git a/Documentation/land.html b/Documentation/land.html index 5399503ee..091a8e0ae 100644 --- a/Documentation/land.html +++ b/Documentation/land.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Documentation/routines.html b/Documentation/routines.html index d33caf801..0318b5608 100644 --- a/Documentation/routines.html +++ b/Documentation/routines.html @@ -21,6 +21,7 @@
  • CARGO
  • CleanUp
  • Client
    • +
  • DATABASE
  • DCSAirbase
  • DCSCoalitionObject
  • DCSCommand
    • @@ -37,7 +38,6 @@
  • DESTROYGROUPSTASK
  • DESTROYRADARSTASK
  • DESTROYUNITTYPESTASK
    • -
  • Database
  • Escort
  • Event
  • GOHOMETASK
    • diff --git a/Moose/Database.lua b/Moose/Database.lua index bdada4e5e..109566d2f 100644 --- a/Moose/Database.lua +++ b/Moose/Database.lua @@ -1,14 +1,26 @@ ---- Administers the Initial Sets of the Mission Templates as defined within the Mission Editor. +--- +-- @module DATABASE +-- @author FlightControl + +Include.File( "Routines" ) +Include.File( "Base" ) +Include.File( "Menu" ) +Include.File( "Group" ) +Include.File( "Event" ) + +--- +-- Administers the Initial Sets of the Mission Templates as defined within the Mission Editor. -- Mission designers can use the DATABASE class to build sets of units belonging to certain: -- --- * coalitions --- * categories --- * countries --- * unit types --- * starting with certain prefix strings. --- --- Note that this is an initial filter set. More to follow, like zones etc. +-- * Coalitions +-- * Categories +-- * Countries +-- * Unit types +-- * Starting with certain prefix strings. -- +-- 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 ... -- -- DATABASE construction methods: -- ================================= @@ -51,18 +63,7 @@ -- * @{#DATABASE.ForEachUnit}: Calls a function for each unit contained within the DATABASE. -- * @{#DATABASE.ForEachGroup}: Calls a function for each group contained within the DATABASE. -- * @{#DATABASE.ForEachUnitInZone}: Calls a function for each unit within a certain zone contained within the DATABASE. --- --- @module Database --- @author FlightControl - - -Include.File( "Routines" ) -Include.File( "Base" ) -Include.File( "Menu" ) -Include.File( "Group" ) -Include.File( "Event" ) - ---- The DATABASE class +-- -- @type DATABASE -- @extends Base#BASE DATABASE = {
    DATABASE.AlivePlayers @@ -199,13 +133,13 @@ The following iterator methods are currently available within the DATABASE:
    DATABASE:FilterCategory(Categories)DATABASE:FilterCategories(Categories)

    Builds a set of units out of categories.
    DATABASE:FilterCoalition(Coalitions)DATABASE:FilterCoalitions(Coalitions)

    Builds a set of units of coalitons.
    DATABASE:FilterGroupPrefix(Prefixes)DATABASE:FilterGroupPrefixes(Prefixes)

    Builds a set of units of defined group prefixes.
    DATABASE:FilterType(Types)DATABASE:FilterTypes(Types)

    Builds a set of units of defined unit types.
    DATABASE:FilterUnitPrefix(Prefixes)DATABASE:FilterUnitPrefixes(Prefixes)

    Builds a set of units of defined unit prefixes.

    		 Client

    The CLIENT models client units in multi player missions.

    +
    DATABASE +
    DESTROYUNITTYPESTASK

    Set TASK to destroy certain unit types.

    -
    Database -

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