Module `Identifiable`

This module contains the IDENTIFIABLE class.

1) #IDENTIFIABLE class, extends Wrapper.Object#OBJECT

The #IDENTIFIABLE class is a 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.

1.1) IDENTIFIABLE constructor:

The IDENTIFIABLE class provides the following functions to construct a IDENTIFIABLE instance:

IDENTIFIABLE.New(): Create a IDENTIFIABLE instance.

1.2) IDENTIFIABLE methods:

The following methods can be used to identify an identifiable object:

IDENTIFIABLE.GetName(): Returns the name of the Identifiable.
IDENTIFIABLE.IsAlive(): Returns if the Identifiable is alive.
IDENTIFIABLE.GetTypeName(): Returns the type name of the Identifiable.
IDENTIFIABLE.GetCoalition(): Returns the coalition of the Identifiable.
IDENTIFIABLE.GetCountry(): Returns the country of the Identifiable.
IDENTIFIABLE.GetDesc(): Returns the descriptor structure of the Identifiable.

Global(s)

Type `IDENTIFIABLE`

IDENTIFIABLE.ClassName
IDENTIFIABLE:GetCallsign()	Gets the CallSign of the IDENTIFIABLE, which is a blank by default.
IDENTIFIABLE:GetCategory()	Returns category of the DCS Identifiable.
IDENTIFIABLE:GetCategoryName()	Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.
IDENTIFIABLE:GetCoalition()	Returns coalition of the Identifiable.
IDENTIFIABLE:GetCountry()	Returns country of the Identifiable.
IDENTIFIABLE:GetDesc()	Returns Identifiable descriptor.
IDENTIFIABLE:GetName()	Returns DCS Identifiable object name.
IDENTIFIABLE:GetTypeName()	Returns the type name of the DCS Identifiable.
IDENTIFIABLE.IdentifiableName	The name of the identifiable.
IDENTIFIABLE:IsAlive()	Returns if the Identifiable is alive.
IDENTIFIABLE:New(IdentifiableName)	Create a new IDENTIFIABLE from a DCSIdentifiable

Global(s)

#IDENTIFIABLE IDENTIFIABLE

Type `Identifiable`

Type `IDENTIFIABLE`

The IDENTIFIABLE class

Field(s)

#string IDENTIFIABLE.ClassName

IDENTIFIABLE:GetCallsign()

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

Return value

#string: The CallSign of the IDENTIFIABLE.

IDENTIFIABLE:GetCategory()

Returns category of the DCS Identifiable.

Return value

Dcs.DCSWrapper.Object#Object.Category: The category ID

IDENTIFIABLE:GetCategoryName()

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

Return value

#string: The DCS Identifiable Category Name

IDENTIFIABLE:GetCoalition()

Returns coalition of the Identifiable.

Return values

Dcs.DCSCoalitionWrapper.Object#coalition.side: The side of the coalition.
#nil: The DCS Identifiable is not existing or alive.

IDENTIFIABLE:GetCountry()

Returns country of the Identifiable.

Return values

Dcs.DCScountry#country.id: The country identifier.
#nil: The DCS Identifiable is not existing or alive.

IDENTIFIABLE:GetDesc()

Returns Identifiable descriptor.

Descriptor type depends on Identifiable category.

Return values

Dcs.DCSWrapper.Identifiable#Identifiable.Desc: The Identifiable descriptor.
#nil: The DCS Identifiable is not existing or alive.

IDENTIFIABLE:GetName()

Returns DCS Identifiable object name.

The function provides access to non-activated objects too.

Return values

#string: The name of the DCS Identifiable.
#nil: The DCS Identifiable is not existing or alive.

IDENTIFIABLE:GetTypeName()

Returns the type name of the DCS Identifiable.

Return values

#string: The type name of the DCS Identifiable.
#nil: The DCS Identifiable is not existing or alive.

#string IDENTIFIABLE.IdentifiableName: The name of the identifiable.

IDENTIFIABLE:IsAlive()

Returns if the Identifiable is alive.

Return values

#boolean: true if Identifiable is alive.
#nil: The DCS Identifiable is not existing or alive.

IDENTIFIABLE:New(IdentifiableName)

Create a new IDENTIFIABLE from a DCSIdentifiable

Parameter

Dcs.DCSWrapper.Identifiable#Identifiable IdentifiableName : The DCS Identifiable name

Return value

#IDENTIFIABLE: self