Module Object
Wrapper -- OBJECT wraps the DCS Object derived objects.
Author: FlightControl
Contributions:
Global(s)
| OBJECT |
OBJECT class, extends Base#BASEOBJECT handles the DCS Object objects:
|
Type DCSObject
| DCSObject.id_ |
The ID of the controllable in DCS |
Type OBJECT
| OBJECT:Destroy() |
Destroys the OBJECT. |
| OBJECT:GetID() |
Returns the unit's unique identifier. |
| OBJECT:New(ObjectName, Test) |
Create a new OBJECT from a DCSObject |
| OBJECT.ObjectName |
The name of the Object. |
Global(s)
- #OBJECT OBJECT
-
OBJECT class, extends Base#BASE
OBJECT handles 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.
OBJECT constructor:
The OBJECT class provides the following functions to construct a OBJECT instance:
- Object#OBJECT.New(): Create a OBJECT instance.
Type Object
Type DCSObject
A DCSObject
Field(s)
- DCSObject.id_
-
The ID of the controllable in DCS
Type OBJECT
Extends Core.Base#BASE
Field(s)
- OBJECT:Destroy()
-
Destroys the OBJECT.
Return values
-
#boolean: true if the object is destroyed.
-
#nil: The DCS Unit is not existing or alive.
-
- OBJECT:GetID()
-
Returns the unit's unique identifier.
Return values
-
Dcs.DCSWrapper.Object#Object.ID: ObjectID
-
#nil: The DCS Object is not existing or alive.
-
- OBJECT:New(ObjectName, Test)
-
Create a new OBJECT from a DCSObject
Parameters
-
Dcs.DCSWrapper.Object#Object ObjectName: The Object name -
Test:
Return value
#OBJECT: self
-
- #string OBJECT.ObjectName
-
The name of the Object.