selectWeapon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *N([a-z ])" to "$1 - n$2")
 
(105 intermediate revisions by 15 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#S|COMREF]]
{{RV|type=command


<h2 style="color:#000066">'''''unit'' selectWeapon ''weapon'''''</h2>
|game1= ofp
|version1= 1.27


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''unit:''' [[Object]]
|game4= arma2
|version4= 1.00


'''weapon:''' [[String]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Compatibility:'''
|arg= local


Added in version '''1.27'''
|eff= global


'''Description:'''
|gr1= Weapons


Select given '''weapon'''.
|descr= Selects the given weapon.


For weapon values see [[Weapons]].
|s1= unitName [[selectWeapon]] muzzleName


|p1= unitName: [[Object]]


'''Example:'''
|p2= muzzleName: [[String]] - name of the weapon or muzzle
{{Feature|important|For weapons that have '''more than one muzzle''', you have to input the '''muzzleName''' and not the '''weaponName'''.
* In {{ofp}}, in most cases, both names are the same. But check.
* In {{arma1}} the weaponNames and muzzleNames are different.
* For muzzle names see [[:Category:Weapons|CfgWeapons]].
}}


soldier1 '''selectWeapon''' "LAWLauncher"
|r1= [[Nothing]]
 
|s2= unit [[selectWeapon]] [weapon, muzzle, firemode]
 
|s2since= arma3 2.08
 
|p21= unit: [[Object]] - person. This argument has to be [[local]], or it can be remote when executed on the [[isServer|server]]
 
|p22= weapon: [[String]] - name of the weapon, personal or vehicle's weapon (see [[weaponState]])
 
|p23= muzzle: [[String]] - name of the selected muzzle (see [[weaponState]])
 
|p24= firemode: [[String]] - name of the firemode (see [[weaponState]])
 
|r2= [[Boolean]] or [[Nothing]] - [[true]] on success, [[false]] on failure, [[Nothing]] when the call to the command is dispatched over network
 
|x1= <sqf>_soldier1 selectWeapon "LAWLauncher";</sqf>
 
|x2= <sqf>player selectWeapon "M203Muzzle";</sqf>
 
|x3= <sqf>player selectWeapon ["arifle_MX_GL_ACO_F", "arifle_MX_GL_ACO_F", "FullAuto"];</sqf>
 
|seealso= [[fire]] [[forceWeaponFire]] [[primaryWeapon]] [[handgunWeapon]] [[secondaryWeapon]] [[weapons]] [[ArmA:_Actions#SWITCHWEAPON|action SwitchWeapon]] [[ArmA:_Actions#SWITCHMAGAZINE|action SwitchMagazine]]
}}
 
{{Note
|user= Dr_Eyeball
|timestamp= 20080805094900
|text= Rather than simply using [[selectWeapon]] to select your default weapon after adding them to your player, it is recommended you use a script instead similar to the following, which caters for multiple muzzles:<br>
SelectWeapon.sqf
<sqf>// Desc: select default weapon & handle multiple muzzles
if (count weapons player > 0) then
{
private ['_type', '_muzzles'];
 
_type = ((weapons player) select 0);
// check for multiple muzzles (eg: GL)
_muzzles = getArray (configFile >> "cfgWeapons" >> _type >> "muzzles");
 
if (count _muzzles > 1) then
{
player selectWeapon (_muzzles select 0);
}
else
{
player selectWeapon _type;
};
};</sqf>
}}
 
{{Note
|user= MaestrO.fr
|timestamp= 20100322154500
|text= Can be used with [[primaryWeapon]] to select the primary weapon.
An example with muzzle care (see Dr_EyeBall note) :
<sqf>if ((primaryWeapon player) != "") then
{
private ['_type', '_muzzles'];
 
_type = primaryWeapon player;
// check for multiple muzzles (eg: GL)
_muzzles = getArray (configFile >> "cfgWeapons" >> _type >> "muzzles");
 
if (count _muzzles > 1) then
{
player selectWeapon (_muzzles select 0);
}
else
{
player selectWeapon _type;
};
};</sqf>
}}

Latest revision as of 16:40, 8 November 2023

Hover & click on the images for description

Description

Description:
Selects the given weapon.
Groups:
Weapons

Syntax

Syntax:
unitName selectWeapon muzzleName
Parameters:
unitName: Object
muzzleName: String - name of the weapon or muzzle
For weapons that have more than one muzzle, you have to input the muzzleName and not the weaponName.
  • In Operation Flashpoint, in most cases, both names are the same. But check.
  • In Armed Assault the weaponNames and muzzleNames are different.
  • For muzzle names see CfgWeapons.
Return Value:
Nothing

Alternative Syntax

Syntax:
unit selectWeapon [weapon, muzzle, firemode]
Parameters:
unit: Object - person. This argument has to be local, or it can be remote when executed on the server
weapon: String - name of the weapon, personal or vehicle's weapon (see weaponState)
muzzle: String - name of the selected muzzle (see weaponState)
firemode: String - name of the firemode (see weaponState)
Return Value:
Boolean or Nothing - true on success, false on failure, Nothing when the call to the command is dispatched over network

Examples

Example 1:
_soldier1 selectWeapon "LAWLauncher";
Example 2:
player selectWeapon "M203Muzzle";
Example 3:
player selectWeapon ["arifle_MX_GL_ACO_F", "arifle_MX_GL_ACO_F", "FullAuto"];

Additional Information

See also:
fire forceWeaponFire primaryWeapon handgunWeapon secondaryWeapon weapons action SwitchWeapon action SwitchMagazine

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
Dr_Eyeball - c
Posted on Aug 05, 2008 - 09:49 (UTC)
Rather than simply using selectWeapon to select your default weapon after adding them to your player, it is recommended you use a script instead similar to the following, which caters for multiple muzzles:
SelectWeapon.sqf
// Desc: select default weapon & handle multiple muzzles if (count weapons player > 0) then { private ['_type', '_muzzles']; _type = ((weapons player) select 0); // check for multiple muzzles (eg: GL) _muzzles = getArray (configFile >> "cfgWeapons" >> _type >> "muzzles"); if (count _muzzles > 1) then { player selectWeapon (_muzzles select 0); } else { player selectWeapon _type; }; };
MaestrO.fr - c
Posted on Mar 22, 2010 - 15:45 (UTC)
Can be used with primaryWeapon to select the primary weapon. An example with muzzle care (see Dr_EyeBall note) :
if ((primaryWeapon player) != "") then { private ['_type', '_muzzles']; _type = primaryWeapon player; // check for multiple muzzles (eg: GL) _muzzles = getArray (configFile >> "cfgWeapons" >> _type >> "muzzles"); if (count _muzzles > 1) then { player selectWeapon (_muzzles select 0); } else { player selectWeapon _type; }; };