isWeaponRested: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|New Scripting Commands}}
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3
|1.42|Game version=
|1.42
|arg= local|Multiplayer Arguments=
|arg= local


|gr1= Weapons |GROUP1=
|gr1= Weapons




| Returns true if weapon is currently rested. |DESCRIPTION=
| Returns true if weapon is currently rested.


| [[isWeaponRested]] unit|SYNTAX=
| [[isWeaponRested]] unit


|p1= unit: [[Object]] |PARAMETER1=
|p1= unit: [[Object]]


| [[Boolean]] |RETURNVALUE=
| [[Boolean]]
   
   
|x1= <code>_rest = [[isWeaponRested]] [[player]]; </code> |EXAMPLE1=
|x1= <code>_rest = [[isWeaponRested]] [[player]]; </code>




| [[isWeaponDeployed]] |SEEALSO=
| [[isWeaponDeployed]]


}}
}}

Revision as of 02:03, 18 January 2021


Hover & click on the images for description

Description

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

Syntax

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

Examples

Example 1:
_rest = isWeaponRested player;

Additional Information

See also:
isWeaponDeployed

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


Posted on July 1, 2015 - 16:44 (UTC)
AgentRevolution
You can force a unit out of bipod or resting with: _unit playMove "";
Posted on July 12, 2015 - 11:00 (UTC)
Killzone Kid
As of 1.49 isWeaponRested player is the only current use of this command. You cannot detect remote player and you cannot detect local unit that is not a player. Might as well be a nullar command without argument.