Last Updates

Moose Development/Moose/Wrapper/Object.lua

@@ -0,0 +1,89 @@
+--- This module contains the OBJECT class.
+-- 
+-- 1) @{Object#OBJECT} class, extends @{Base#BASE}
+-- ===========================================================
+-- The @{Object#OBJECT} class is a wrapper class to handle the DCS Object objects:
+--
+--  * Support all DCS Object APIs.
+--  * Enhance with Object specific APIs not in the DCS Object API set.
+--  * Manage the "state" of the DCS Object.
+--
+-- 1.1) OBJECT constructor:
+-- ------------------------------
+-- The OBJECT class provides the following functions to construct a OBJECT instance:
+--
+--  * @{Object#OBJECT.New}(): Create a OBJECT instance.
+--
+-- 1.2) OBJECT methods:
+-- --------------------------
+-- The following methods can be used to identify an Object object:
+-- 
+--    * @{Object#OBJECT.GetID}(): Returns the ID of the Object object.
+-- 
+-- ===
+-- 
+-- @module Object
+-- @author FlightControl
+
+--- The OBJECT class
+-- @type OBJECT
+-- @extends Base#BASE
+-- @field #string ObjectName The name of the Object.
+OBJECT = {
+  ClassName = "OBJECT",
+  ObjectName = "",
+}
+
+
+--- A DCSObject
+-- @type DCSObject
+-- @field id_ The ID of the controllable in DCS
+
+--- Create a new OBJECT from a DCSObject
+-- @param #OBJECT self
+-- @param DCSObject#Object ObjectName The Object name
+-- @return #OBJECT self
+function OBJECT:New( ObjectName )
+  local self = BASE:Inherit( self, BASE:New() )
+  self:F2( ObjectName )
+  self.ObjectName = ObjectName
+  return self
+end
+
+
+--- Returns the unit's unique identifier.
+-- @param Object#OBJECT self
+-- @return DCSObject#Object.ID ObjectID
+-- @return #nil The DCS Object is not existing or alive.  
+function OBJECT:GetID()
+  self:F2( self.ObjectName )
+
+  local DCSObject = self:GetDCSObject()
+  
+  if DCSObject then
+    local ObjectID = DCSObject:getID()
+    return ObjectID
+  end 
+
+  return nil
+end
+
+--- Destroys the OBJECT.
+-- @param #OBJECT self
+-- @return #nil The DCS Unit is not existing or alive.  
+function OBJECT:Destroy()
+  self:F2( self.ObjectName )
+
+  local DCSObject = self:GetDCSObject()
+  
+  if DCSObject then
+  
+    DCSObject:destroy()
+  end
+
+  return nil
+end
+
+
+
+