DCS Class Static Object

From DCS World Wiki - Hoggitworld.com
Revision as of 00:40, 4 January 2023 by Loophole 62ndFF (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Scripting Root

Class Name: StaticObject Added with: 1.2.0
Extends: none
Inherits: Object, Coalition Object
Description: Represents static objects added in the Mission Editor or via scripting commands.
Member Functions: getID, getLife, getCargoDisplayName, getCargoWeight, getDrawArgumentValue


Inherited from Object Class: isExist, destroy, getCategory, getTypeName, getDesc, hasAttribute, getName, getPoint, getPosition, getVelocity, inAir

Inherited from Coalition Object Class: getCoalition, getCountry

Obtained Via: Static Functions Functions Events
StaticObject.getByName

StaticObject.getDescByName

Enumerator Types: StaticObject.Category enum that stores StaticObject categories.
Note that StaticObject.Category values are not obtained by calling static:getCategory() - that calls Object.getCategory(static) and will always return the value Object.Category.STATIC. Instead you need to use static:getDesc().category to find the StaticObject.Category!
StaticObject.Category = {
 "VOID": 0,
 "UNIT": 1,
 "WEAPON": 2,
 "STATIC": 3,
 "BASE": 4,
 "SCENERY": 5,
 "CARGO": 6 
}
Description Table Structure:
Notes: Cargo objects are still static objects and retain access to the whole static object class functions. The function Object.getCategory() will return a value of 6 for cargo objects instead of 3 as it would for any other type of static object.