isWeaponDeployed: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "Category:Scripting_Commands_Arma_3 Category:Arma_3:_New_Scripting_Commands_List {{Command|= Comments __________________________________________________________________...")
 
m (Some wiki formatting)
 
(51 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Scripting_Commands_Arma_3]]
{{RV|type=command
[[Category:Arma_3:_New_Scripting_Commands_List]]
{{Command|= Comments
____________________________________________________________________________________________


| arma3dev |= Game name
|game1= arma3
|version1= 1.42


|1.43|= Game version
|arg= global


____________________________________________________________________________________________
|gr1= Weapons


| Returns true if weapon is currently deployed. |= Description
|descr= Returns true if weapon is currently deployed.
____________________________________________________________________________________________


| [[isWeaponDeployed]] unit|= Syntax
|s1= [[isWeaponDeployed]] unit


|p1= unit: [[Object]] |= Parameter 1
|p1= unit: [[Object]]


| [[Boolean]] |= Return value
|r1= [[Boolean]]
____________________________________________________________________________________________
 
|x1= <code>_dep = [[isWeaponDeployed]] [[player]]; </code> |= Example 1


____________________________________________________________________________________________
|s2= [[isWeaponDeployed]] [unit, onGround]


| [[isWeaponRested]] |= See also
|s2since= arma3 2.06


|p21= unit: [[Object]]
|p22= onGround: [[Boolean]] - (Optional) [[true]] to check if deployed on ground, [[false]] to check if deployed on object. Omitted - same as main syntax.
|r2= [[Boolean]]
|x1= <sqf>_dep = isWeaponDeployed player;</sqf>
|x2= <sqf>_depOnObj = isWeaponDeployed [player, false];</sqf>
|seealso= [[isWeaponRested]] [[canDeployWeapon]]
}}
}}


<!-- CONTINUE Notes -->
{{Note
|user= AgentRev
|timestamp= 20150701164400
|text= You can force a unit out of bipod or resting with:
<sqf>_unit playMove "";</sqf>
}}


<!-- DISCONTINUE Notes -->
{{Note
|user= Beno 83au
|timestamp= 20170304035800
|text= [[playMove]], as well as [[switchMove]], appears to not work when forcing a player out of being deployed. A more reliable method is:
<sqf>_player setPos (_player modelToWorld [0,0,0]);</sqf>
}}

Latest revision as of 15:54, 13 May 2022

Arma 3 logo black.png1.42
GAGlobal
Hover & click on the images for description

Description

Description:
Returns true if weapon is currently deployed.
Groups:
Weapons

Syntax

Syntax:
isWeaponDeployed unit
Parameters:
unit: Object
Return Value:
Boolean

Alternative Syntax

Syntax:
isWeaponDeployed [unit, onGround]
Parameters:
unit: Object
onGround: Boolean - (Optional) true to check if deployed on ground, false to check if deployed on object. Omitted - same as main syntax.
Return Value:
Boolean

Examples

Example 1:
_dep = isWeaponDeployed player;
Example 2:
_depOnObj = isWeaponDeployed [player, false];

Additional Information

See also:
isWeaponRested canDeployWeapon

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
AgentRev - c
Posted on Jul 01, 2015 - 16:44 (UTC)
You can force a unit out of bipod or resting with:
_unit playMove "";
Beno 83au - c
Posted on Mar 04, 2017 - 03:58 (UTC)
playMove, as well as switchMove, appears to not work when forcing a player out of being deployed. A more reliable method is:
_player setPos (_player modelToWorld [0,0,0]);
Retrieved from "https://community.bistudio.com/wiki?title=isWeaponDeployed&oldid=321095"