Difference between revisions of "DCS func getDrawArgumentValue"

From DCS World Wiki - Hoggitworld.com
(Created page with "{{Template:dcs_funcs |fName= getDrawArgumentValue |vNum= 1.2.0 |par1= Unit |par2= Static Object |par3= |par4= |desc= Re...")
 
 
(3 intermediate revisions by the same user not shown)
Line 17: Line 17:
  
 
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.  
 
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.
  
 
|rtnType= number
 
|rtnType= number
Line 26: Line 28:
 
|reqName1= Self
 
|reqName1= Self
  
|reqType2=
+
|reqType2= number
 +
 
 +
|reqName2= arg
  
|reqName2=
+
|reqType3=
  
 
|optType1=
 
|optType1=
Line 34: Line 38:
 
|optType2=
 
|optType2=
  
|examples=  
+
|examples= When checking the Huey
 +
 
 +
  local u = Unit.getByName('whoopwhoop')
 +
    if u:getDrawArgumentValue(43) == 1 then
 +
      -- left gunner door open
 +
    else
 +
      -- left gunner door closed
 +
  end
 +
 
  
 
|related= [[DCS_Class_Unit|'''Unit Functions:''']] {{listOfScriptingUnitFuncs}}
 
|related= [[DCS_Class_Unit|'''Unit Functions:''']] {{listOfScriptingUnitFuncs}}

Latest revision as of 23:22, 18 May 2021

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
   else
      -- left gunner door closed
 end
Related Functions: Unit Functions: isActive, getPlayerName, getID, getNumber, 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

Notes: