Revision of core classes documentation.

This commit is contained in:
FlightControl
2018-10-09 19:30:57 +02:00
parent e6f51af34c
commit f03a2e3657
20 changed files with 298 additions and 86 deletions

View File

@@ -1,7 +1,24 @@
--- **Core** -- ZONE classes define **zones** within your mission of **various forms**, with **various capabilities**.
--- **Core** - Define zones within your mission of various forms, with various capabilities.
--
-- ===
--
-- ## Features:
--
-- * Create radius zones.
-- * Create trigger zones.
-- * Create polygon zones.
-- * Create moving zones around a unit.
-- * Create moving zones around a group.
-- * Provide the zone behaviour. Some zones are static, while others are moveable.
-- * Enquiry if a coordinate is within a zone.
-- * Smoke zones.
-- * Set a zone probability to control zone selection.
-- * Get zone coordinates.
-- * Get zone properties.
-- * Get zone bounding box.
-- * Set/get zone name.
--
--
-- There are essentially two core functions that zones accomodate:
--
-- * Test if an object is within the zone boundaries.