isWeaponDeployed: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Some wiki formatting)
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{GameCategory|arma3|Scripting Commands}}
{{RV|type=command
{{GameCategory|arma3|New Scripting Commands}}
{{Command|Comments=


| arma3 |Game name=
|game1= arma3
|1.42|Game version=
|version1= 1.42
|arg= global|Multiplayer Arguments=


|gr1= Weapons |GROUP1=
|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]] |PARAMETER1=
|p1= unit: [[Object]]


| [[Boolean]] |RETURNVALUE=
|r1= [[Boolean]]
 
|x1= <code>_dep = [[isWeaponDeployed]] [[player]]; </code> |EXAMPLE1=


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


| [[isWeaponRested]] |SEEALSO=
|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]]


<!-- CONTINUE Notes -->
|x1= <sqf>_dep = isWeaponDeployed player;</sqf>


<!-- DISCONTINUE Notes -->
|x2= <sqf>_depOnObj = isWeaponDeployed [player, false];</sqf>


<!-- CONTINUE Notes -->
|seealso= [[isWeaponRested]] [[canDeployWeapon]]
<dl class="command_description">
}}
<dd class="notedate">Posted on July 1, 2015 - 16:44 (UTC)</dd>
<dt class="note">[[User:AgentRevolution|AgentRevolution]]</dt>
<dd class="note">
You can force a unit out of bipod or resting with:
<code>_unit [[playMove]] "";</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= AgentRev
<dd class="notedate">Posted on March 4, 2017 - 03:58 (UTC)</dd>
|timestamp= 20150701164400
<dt class="note">[[User:Beno 83au|Beno 83au]]</dt>
|text= You can force a unit out of bipod or resting with:
<dd class="note">
<sqf>_unit playMove "";</sqf>
playMove, as well as switchMove, appear to not work when forcing a player out of being deployed. A more reliable method is:<br><code>_player setPos (_player modelToWorld [0,0,0]);</code>
}}
</dd>
 
</dl>
{{Note
<!-- DISCONTINUE Notes -->
|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"