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 @@
-
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:
-
-
- - coalitions
- - categories
- - countries
- - unit types
- - starting with certain prefix strings.
-
-
-
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:
-
-
+
+
| 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.
|
@@ -217,7 +151,7 @@ The following iterator methods are currently available within the DATABASE:
- | DATABASE:FilterGroupPrefix(Prefixes) |
+ DATABASE:FilterGroupPrefixes(Prefixes) |
Builds a set of units of defined group prefixes.
|
@@ -235,13 +169,13 @@ The following iterator methods are currently available within the DATABASE:
- | 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.
|
@@ -365,11 +299,76 @@ The following iterator methods are currently available within the DATABASE:
-
+
+
+Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.
+
-
-
-The DATABASE class
+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.
+
+
+ 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 @@
Client |
The CLIENT models client units in multi player missions.
+ |
+
+
+ | DATABASE |
+
+
|
@@ -183,12 +189,6 @@
| DESTROYUNITTYPESTASK |
Set TASK to destroy certain unit types.
- |
-
-
- | Database |
-
- Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.
|
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 = {