reload: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(15 intermediate revisions by 4 users not shown)
Line 18: Line 18:
|gr1= Weapons
|gr1= Weapons


|descr= * Old syntax: Reload first found muzzle that needs reloading (with some inconsistencies).  
|descr=
* Alternative syntax (Since Arma 3 v2.08.148609): This syntax allows to reload given muzzle with given magazine while playing proper animation. If param is omitted or is empty string, default value is used. The default behaviour is to find best matching magazine for given muzzle from the pool of available magazines. If specific magazine is requested, the reload will fail if unit has run out of this type of magazines. If empty array [] is given, the behaviour is similar to player pressing "Reload" key. The command reloads the given muzzle but doesn't select it. In case of [[currentThrowable | throwable]] muzzles, each throwable has own muzzle, they are autoreloaded after throw. Using reload on the trowable muzzle will just swap throwable for another one of the same type from inventory.
Main syntax: Reload first found muzzle that needs reloading (with some inconsistencies).<br>
Alternative syntax: this syntax allows to reload given muzzle with given magazine while playing proper animation.
If ''param'' is omitted or is empty string, default value is used. The default behaviour is to find the best matching magazine for the provided muzzle from the pool of available magazines.
If specific magazine is requested, the reload will fail if unit has run out of this type of magazines. If an empty array <sqf inline>[]</sqf> is given, the behaviour is similar to pressing the "Reload" key.
The command reloads the given muzzle but does not select it. In case of [[currentThrowable|throwable]] muzzles, each throwable has its own muzzle, they are autoreloaded after throw.
Using [[reload]] on the throwable muzzle will just swap throwable for another one of the same type from inventory.
 
|s1= [[reload]] unitName
|s1= [[reload]] unitName


Line 27: Line 33:


|s2= unit [[reload]] [muzzle, magazine]
|s2= unit [[reload]] [muzzle, magazine]
|s2since= Arma3 2.08
|s2since= arma3 2.08


|p21= unit: [[Object]] - person
|p21= unit: [[Object]] - person
|p22= muzzle (Optional): [[String]] - muzzle name or "" for current muzzle. Default: [[currentMuzzle]]
 
|p23= magazine (Optional): [[String]] - magazine name or "" for given muzzle magazine. Default: given muzzle magazine. If given muzzle is [[currentMuzzle]] then [[currentMagazine]]
|p22= muzzle: [[String]] - (Optional, default [[currentMuzzle]]) muzzle name or "" for the current muzzle.
 
|p23= magazine: [[String]] - (Optional, default given muzzle magazine) magazine name or "" for given muzzle's magazine. If given muzzle is [[currentMuzzle]] then [[currentMagazine]]


|r2= [[Boolean]] - [[true]] on success
|r2= [[Boolean]] - [[true]] on success


|x1= <code>[[if]] ([[needReload]] [[player]] == 1) [[then]] { [[reload]] [[player]] };</code>
|x1= <sqf>if (needReload player == 1) then { reload player };</sqf>
|x2 = <code>[[player]] [[reload]] ["GL_3GL_F", "1Rnd_HE_Grenade_shell"];</code>
 
|x2= <sqf>player reload ["GL_3GL_F", "1Rnd_HE_Grenade_shell"];</sqf>
 
|x3= Reload current muzzle:
<sqf>player reload [];</sqf>


|seealso= [[reloadEnabled]], [[needReload]], [[enableReload]], [[setWeaponReloadingTime]]
|seealso= [[reloadEnabled]] [[needReload]] [[enableReload]] [[setWeaponReloadingTime]]
}}
}}

Latest revision as of 10:06, 3 October 2023

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Main syntax: Reload first found muzzle that needs reloading (with some inconsistencies).
Alternative syntax: this syntax allows to reload given muzzle with given magazine while playing proper animation. If param is omitted or is empty string, default value is used. The default behaviour is to find the best matching magazine for the provided muzzle from the pool of available magazines. If specific magazine is requested, the reload will fail if unit has run out of this type of magazines. If an empty array [] is given, the behaviour is similar to pressing the "Reload" key. The command reloads the given muzzle but does not select it. In case of throwable muzzles, each throwable has its own muzzle, they are autoreloaded after throw. Using reload on the throwable muzzle will just swap throwable for another one of the same type from inventory.
Groups:
Weapons

Syntax

Syntax:
reload unitName
Parameters:
unitName: Object
Return Value:
Nothing

Alternative Syntax

Syntax:
unit reload [muzzle, magazine]
Parameters:
unit: Object - person
muzzle: String - (Optional, default currentMuzzle) muzzle name or "" for the current muzzle.
magazine: String - (Optional, default given muzzle magazine) magazine name or "" for given muzzle's magazine. If given muzzle is currentMuzzle then currentMagazine
Return Value:
Boolean - true on success

Examples

Example 1:
if (needReload player == 1) then { reload player };
Example 2:
player reload ["GL_3GL_F", "1Rnd_HE_Grenade_shell"];
Example 3:
Reload current muzzle:
player reload [];

Additional Information

See also:
reloadEnabled needReload enableReload setWeaponReloadingTime

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
Retrieved from "https://community.bistudio.com/wiki?title=reload&oldid=347639"