Difference between revisions of "DCS func getDrawArgumentValue"

Latest revision as of 00:07, 21 March 2022

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, getCategoryEx, 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
Notes:

@@ 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.
+If draw argument value is invalid for the unit in question a value of 0 will be returned.
 |rtnType= number
@@ Line 26: / Line 28: @@
 |reqName1= Self
-|reqType2=
+|reqType2= number
+|reqName2= arg
-|reqName2=
+|reqType3=
 |optType1=
@@ Line 34: / Line 38: @@
 |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}}
@@ Line 44: / Line 56: @@
 }}
 [[Category:Class Functions|getDrawArgumentValue]]
+[[Category:Game Patch 1.2.0|getDrawArgumentValue]]