Updated documentation

DATABASE
BASE
SPAWN
ESCORT
This commit is contained in:
FlightControl
2016-04-30 09:22:36 +02:00
parent 6ed7796b6d
commit 94960b4cb3
48 changed files with 369 additions and 211 deletions

View File

@@ -1,15 +1,7 @@
---
-- @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.
--- Manage sets of units and groups.
--
-- @{#Database} class
-- ==================
-- Mission designers can use the DATABASE class to build sets of units belonging to certain:
--
-- * Coalitions
@@ -18,9 +10,11 @@ Include.File( "Event" )
-- * 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 ...
-- 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:
-- =================================
@@ -64,6 +58,17 @@ Include.File( "Event" )
-- * @{#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" )
--- DATABASE class
-- @type DATABASE
-- @extends Base#BASE
DATABASE = {