DCS func getDrawArgumentValue

From DCS World Wiki - Hoggitworld.com
Revision as of 00:07, 21 March 2022 by Grimes (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Scripting Root

Envrioment: Mission Scripting
Function: getDrawArgumentValue Added with: 1.2.0
Member Of: Unit, Static Object
Syntax: number Unit.getDrawArgumentValue(Class Self , number arg )
Description: Returns the current value for an animation argument on the external model of the given object. Each model animation has an id tied to with different values representing different states of the model. Animation arguments can be figured out by opening the respective 3d model in the modelviewer.

For example you can determine the rotation and orientation of the barrel of a Tanks cannon by checking its animation arguments. More practically you can determine whether or not a helicopters doors are open.

If draw argument value is invalid for the unit in question a value of 0 will be returned.

Return Value: number
Return Example: -1 to +1
Examples: When checking the Huey
 local u = Unit.getByName('whoopwhoop')
   if u:getDrawArgumentValue(43) == 1 then
      -- left gunner door open
      -- left gunner door closed
Related Functions: Unit Functions: isActive, getPlayerName, getID, getNumber, getObjectID, getController, getGroup, getCallsign, getLife, getLife0, getFuel, getAmmo, getSensors, hasSensors, getRadar, getDrawArgumentValue, getNearestCargos, enableEmission, getDescentCapacity

Object Functions: isExist, destroy, getCategory, getTypeName, getDesc, hasAttribute, getName, getPoint, getPosition, getVelocity, inAir

Coalition Object Functions: getCoalition, getCountry