initial commit

MOOSE/Moose Development/Moose/Wrapper/Identifiable.lua

@@ -0,0 +1,267 @@
+--- **Wrapper** - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ### Contributions: 
+-- 
+-- ===
+-- 
+-- @module Wrapper.Identifiable
+-- @image MOOSE.JPG
+
+--- @type IDENTIFIABLE
+-- @extends Wrapper.Object#OBJECT
+-- @field #string IdentifiableName The name of the identifiable.
+
+--- Wrapper class to handle the DCS Identifiable objects.
+--
+--  * Support all DCS Identifiable APIs.
+--  * Enhance with Identifiable specific APIs not in the DCS Identifiable API set.
+--  * Manage the "state" of the DCS Identifiable.
+--
+-- ## IDENTIFIABLE constructor
+-- 
+-- The IDENTIFIABLE class provides the following functions to construct a IDENTIFIABLE instance:
+--
+--  * @{#IDENTIFIABLE.New}(): Create a IDENTIFIABLE instance.
+--
+-- @field #IDENTIFIABLE
+IDENTIFIABLE = {
+  ClassName = "IDENTIFIABLE",
+  IdentifiableName = "",
+}
+
+local _CategoryName = { 
+  [Unit.Category.AIRPLANE]      = "Airplane",
+  [Unit.Category.HELICOPTER]    = "Helicopter",
+  [Unit.Category.GROUND_UNIT]   = "Ground Identifiable",
+  [Unit.Category.SHIP]          = "Ship",
+  [Unit.Category.STRUCTURE]     = "Structure",
+  }
+
+--- Create a new IDENTIFIABLE from a DCSIdentifiable
+-- @param #IDENTIFIABLE self
+-- @param #string IdentifiableName The DCS Identifiable name
+-- @return #IDENTIFIABLE self
+function IDENTIFIABLE:New( IdentifiableName )
+  local self = BASE:Inherit( self, OBJECT:New( IdentifiableName ) )
+  self:F2( IdentifiableName )
+  self.IdentifiableName = IdentifiableName
+  return self
+end
+
+--- Returns if the Identifiable is alive.  
+-- If the Identifiable is not alive, nil is returned.  
+-- If the Identifiable is alive, true is returned.  
+-- @param #IDENTIFIABLE self
+-- @return #boolean true if Identifiable is alive or `#nil` if the Identifiable is not existing or is not alive.  
+function IDENTIFIABLE:IsAlive()
+  self:F3( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject() -- DCS#Object
+  
+  if DCSIdentifiable then
+    local IdentifiableIsAlive  = DCSIdentifiable:isExist()
+    return IdentifiableIsAlive
+  end 
+  
+  return false
+end
+
+
+
+
+--- Returns DCS Identifiable object name. 
+-- The function provides access to non-activated objects too.
+-- @param #IDENTIFIABLE self
+-- @return #string The name of the DCS Identifiable or `#nil`.  
+function IDENTIFIABLE:GetName()
+  local IdentifiableName = self.IdentifiableName
+  return IdentifiableName
+end
+
+
+--- Returns the type name of the DCS Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return #string The type name of the DCS Identifiable.
+function IDENTIFIABLE:GetTypeName()
+  self:F2( self.IdentifiableName )
+  
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableTypeName = DCSIdentifiable:getTypeName()
+    self:T3( IdentifiableTypeName )
+    return IdentifiableTypeName
+  end
+
+  self:F( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+
+--- Returns object category of the DCS Identifiable. One of
+-- 
+--  * Object.Category.UNIT = 1
+--  * Object.Category.WEAPON = 2
+--  * Object.Category.STATIC = 3
+--  * Object.Category.BASE = 4
+--  * Object.Category.SCENERY = 5
+--  * Object.Category.Cargo = 6
+--  
+-- @param #IDENTIFIABLE self
+-- @return DCS#Object.Category The category ID, i.e. a number.
+function IDENTIFIABLE:GetCategory()
+  self:F2( self.ObjectName )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    local ObjectCategory = DCSObject:getCategory()
+    self:T3( ObjectCategory )
+    return ObjectCategory
+  end
+
+  return nil
+end
+
+
+--- Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.
+-- @param #IDENTIFIABLE self
+-- @return #string The DCS Identifiable Category Name
+function IDENTIFIABLE:GetCategoryName()
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableCategoryName = _CategoryName[ self:GetDesc().category ]
+    return IdentifiableCategoryName
+  end
+  
+  self:F( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Returns coalition of the Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return DCS#coalition.side The side of the coalition or `#nil` The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetCoalition()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableCoalition = DCSIdentifiable:getCoalition()
+    self:T3( IdentifiableCoalition )
+    return IdentifiableCoalition
+  end 
+  
+  self:F( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Returns the name of the coalition of the Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return #string The name of the coalition.
+-- @return #nil The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetCoalitionName()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+  
+    -- Get coalition ID.
+    local IdentifiableCoalition = DCSIdentifiable:getCoalition()
+    self:T3( IdentifiableCoalition )
+    
+    return UTILS.GetCoalitionName(IdentifiableCoalition)
+    
+  end 
+  
+  self:F( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Returns country of the Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return DCS#country.id The country identifier or `#nil` The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetCountry()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableCountry = DCSIdentifiable:getCountry()
+    self:T3( IdentifiableCountry )
+    return IdentifiableCountry
+  end 
+  
+  self:F( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Returns country name of the Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return #string Name of the country.  
+function IDENTIFIABLE:GetCountryName()
+  self:F2( self.IdentifiableName ) 
+  local countryid=self:GetCountry()
+  for name,id in pairs(country.id) do
+    if countryid==id then
+      return name
+    end
+  end
+end
+
+--- Returns Identifiable descriptor. Descriptor type depends on Identifiable category.
+-- @param #IDENTIFIABLE self
+-- @return DCS#Object.Desc The Identifiable descriptor or `#nil` The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetDesc()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject() -- DCS#Object
+  
+  if DCSIdentifiable then
+    local IdentifiableDesc = DCSIdentifiable:getDesc()
+    self:T2( IdentifiableDesc )
+    return IdentifiableDesc
+  end
+  
+  self:F( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Check if the Object has the attribute.
+-- @param #IDENTIFIABLE self
+-- @param #string AttributeName The attribute name.
+-- @return #boolean true if the attribute exists or `#nil` The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:HasAttribute( AttributeName )
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableHasAttribute = DCSIdentifiable:hasAttribute( AttributeName )
+    self:T2( IdentifiableHasAttribute )
+    return IdentifiableHasAttribute
+  end
+  
+  self:F( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Gets the CallSign of the IDENTIFIABLE, which is a blank by default.
+-- @param #IDENTIFIABLE self
+-- @return #string The CallSign of the IDENTIFIABLE.
+function IDENTIFIABLE:GetCallsign()
+  return ''
+end
+
+--- Gets the threat level.
+-- @param #IDENTIFIABLE self
+-- @return #number Threat level.
+-- @return #string Type.
+function IDENTIFIABLE:GetThreatLevel()
+  return 0, "Scenery"
+end