Module Group
-This module contains the GROUP class.
+Wrapper -- GROUP is a wrapper class for the DCS Class Group.
++
The #GROUP class is a wrapper class to handle the DCS Group objects:
-
@@ -138,8 +140,6 @@
-
-
Returns if the DCS Group is alive.
+Returns if the Group is alive.
-When the group exists at run-time, this method will return true, otherwise false.
+The Group must:
-Return value
+-
+
- Exist at run-time. +
- Has at least one unit. +
When the first Unit of the Group is active, it will return true. +If the first Unit of the Group is inactive, it will return false.
+ + +Return values
+-
+
-
#boolean: -true if the DCS Group is alive.
+true if the Group is alive and active. +
+ -
+
+
#boolean: +false if the Group is alive but inactive.
+ +
+ -
+
+
#nil: +if the group does not exist anymore.
+ +
+
- @@ -485,7 +489,7 @@ true if Identifiable is alive.
-
#nil: -The DCS Identifiable is not existing or alive.
+if the Identifiable is not existing or is not alive. -
- #number
MOVEMENT.AliveUnits
@@ -200,9 +199,6 @@ on defined intervals (currently every minute).
-
-
Contains the counter how many units are currently alive
- - - #boolean + SPAWN.SpawnUnControlled @@ -3292,20 +3286,6 @@ True = Continue Scheduler
GROUP class, extends Controllable#CONTROLLABLE
-GROUP reference methods
-For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _DATABASE object.
Returns if the DCS Group is alive.
+Returns if the Group is alive.
GROUP class, extends Controllable#CONTROLLABLE
-GROUP reference methods
-For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _DATABASE object.
@@ -1293,16 +1291,41 @@ true if DCS Group contains AirPlanes.-
diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html
index 338914a14..26302176c 100644
--- a/docs/Documentation/Identifiable.html
+++ b/docs/Documentation/Identifiable.html
@@ -474,6 +474,10 @@ The DCS Identifiable is not existing or alive.
Returns if the Identifiable is alive.
+ +If the Identifiable is not alive, nil is returned.
+If the Identifiable is alive, true is returned.
Return values
-
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html
index ea6982b4c..3c2379643 100644
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@@ -872,12 +872,6 @@ and any spaces before and after the resulting name are removed.
-
-
- - - - -SPAWN.uncontrolled - - -
- - - -
Module Unit
-This module contains the UNIT class.
+Wrapper - UNIT is a wrapper class for the DCS Class Unit.
-1) #UNIT class, extends Controllable#CONTROLLABLE
++
The #UNIT class is a wrapper class to handle the DCS Unit objects:
- Support all DCS Unit APIs.
- Enhance with Unit specific APIs not in the DCS Unit API set.
- Handle local Unit Controller. -
- Manage the "state" of the DCS Unit. +
- Manage the "state" of the DCS Unit. +
1.1) UNIT reference methods
-For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _DATABASE object. -This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Unit objects are spawned (using the SPAWN class).
- -The UNIT class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference -using the DCS Unit or the DCS UnitName.
- -Another thing to know is that UNIT objects do not "contain" the DCS Unit object. -The UNIT methods will reference the DCS Unit object by name when it is needed during API execution. -If the DCS Unit object does not exist or is nil, the UNIT methods will return nil and log an exception in the DCS.log file.
- -The UNIT class provides the following functions to retrieve quickly the relevant UNIT instance:
- --
-
- UNIT.Find(): Find a UNIT instance from the _DATABASE object using a DCS Unit object. -
- UNIT.FindByName(): Find a UNIT instance from the _DATABASE object using a DCS Unit name. -
IMPORTANT: ONE SHOULD NEVER SANATIZE these UNIT OBJECT REFERENCES! (make the UNIT object references nil).
- -1.2) DCS UNIT APIs
-The DCS Unit APIs are used extensively within MOOSE. The UNIT class has for each DCS Unit API a corresponding method. -To be able to distinguish easily in your code the difference between a UNIT API call and a DCS Unit API call, -the first letter of the method is also capitalized. So, by example, the DCS Unit method DCSWrapper.Unit#Unit.getName() -is implemented in the UNIT class as UNIT.GetName().
- -1.3) Smoke, Flare Units
-The UNIT class provides methods to smoke or flare units easily. -The UNIT.SmokeBlue(), UNIT.SmokeGreen(),UNIT.SmokeOrange(), UNIT.SmokeRed(), UNIT.SmokeRed() methods -will smoke the unit in the corresponding color. Note that smoking a unit is done at the current position of the DCS Unit. -When the DCS Unit moves for whatever reason, the smoking will still continue! -The UNIT.FlareGreen(), UNIT.FlareRed(), UNIT.FlareWhite(), UNIT.FlareYellow() -methods will fire off a flare in the air with the corresponding color. Note that a flare is a one-off shot and its effect is of very short duration.
- -1.4) Location Position, Point
-The UNIT class provides methods to obtain the current point or position of the DCS Unit. -The UNIT.GetPointVec2(), UNIT.GetVec3() will obtain the current location of the DCS Unit in a Vec2 (2D) or a point in a Vec3 (3D) vector respectively. -If you want to obtain the complete 3D position including ori�ntation and direction vectors, consult the UNIT.GetPositionVec3() method respectively.
- -1.5) Test if alive
-The UNIT.IsAlive(), UNIT.IsActive() methods determines if the DCS Unit is alive, meaning, it is existing and active.
- -1.6) Test for proximity
-The UNIT class contains methods to test the location or proximity against zones or other objects.
- -1.6.1) Zones
-To test whether the Unit is within a zone, use the UNIT.IsInZone() or the UNIT.IsNotInZone() methods. Any zone can be tested on, but the zone must be derived from Zone#ZONE_BASE.
- -1.6.2) Units
-Test if another DCS Unit is within a given radius of the current DCS Unit, use the UNIT.OtherUnitInRadius() method.
- -Global(s)
| UNIT |
+UNIT class, extends Controllable#CONTROLLABLE- |
-
| i | -
-
+ For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _DATABASE object. |
Type UNIT
| UNIT.ClassName | -- - | -||
| UNIT:Find(DCSUnit) |
Finds a UNIT from the _DATABASE using a DCSUnit object. @@ -333,6 +272,12 @@ If you want to obtain the complete 3D position including ori� | UNIT:IsAir() |
Returns if the unit is of an air category. + |
+
| UNIT:IsAlive() | +
+ Returns if the Unit is alive. |
||
| Group |
- This module contains the GROUP class. +Wrapper -- GROUP is a wrapper class for the DCS Class Group. |
||
| Unit |
- This module contains the UNIT class. +Wrapper - UNIT is a wrapper class for the DCS Class Unit. |
||