BIS fnc limitWeaponItems: Difference between revisions

Latest revision as of 12:26, 8 November 2023

1.00

Hover & click on the images for description

Description

Description:: Keeps or remove unit's weapon attachments based on probability user sets. Apply for primary, secondary or handgun weapon separately.
Execution:: call
Groups:: Inventory

Syntax

Syntax:

[unit, mode, chanceOptics, chanceAttach, chanceMuzzle, chanceUnderbarrel] call BIS_fnc_limitWeaponItems

Parameters:

unit: Object - target unit

mode: Number - (Optional, default 0) can be:

1 = primary weapon
2 = secondary weapon
3 = handgun

chanceOptics: Number or Array in format ["itemClass", chance] - (Optional, default 50) chance to keep optics from 0 to 100%

if ["itemClassname", number] is used, the function will add that attachment if it passes the check. If not, the current attachment will be removed.

chanceAttach: Number or Array in format ["itemClass", chance] - (Optional, default 50) chance to keep side attachments from 0 to 100%

chanceMuzzle: Number or Array in format ["itemClass", chance] - (Optional, default 50) chance to keep muzzle attachment from 0 to 100%

chanceUnderbarrel: Number or Array in format ["itemClass",chance] - (Optional, default 50) chance to keep underbarrel attachment from 0 to 100%

Return Value:

Boolean

Examples

Example 1:: player call BIS_fnc_limitWeaponItems;
Example 2:: [[player, 0, 25, 50, 75, 100]] call BIS_fnc_limitWeaponItems;
Example 3:: [[player, 0, ["optic_lrps", 100], ["acc_pointer_ir", 100], ["muzzle_snds_B", 100], ["bipod_01_F_blk", 100]]] call BIS_fnc_limitWeaponItems;

Additional Information

See also:: BIS_fnc_limitAmmunition BIS_fnc_limitItems

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Inventory
-|1.00|= Game version
+|descr= Keeps or remove unit's weapon attachments based on probability user sets. Apply for primary, secondary or handgun weapon separately.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [unit, mode, chanceOptics, chanceAttach, chanceMuzzle, chanceUnderbarrel] call [[BIS_fnc_limitWeaponItems]]
-	Author: Vaclav "Watty Watts" Oliva
-	Description:
+|p1= unit: [[Object]] - target unit
-	Keeps or remove unit's weapon attachments based on probability user sets. Apply for primary, secondary or handgun weapon separately.
-	- use 0-100 to randomize the chance of keeping the current attachment
-	- use 100 to always keep the attachment
-	- use 0 to always remove the attachment
-	Parameters:
+|p2= mode: [[Number]] - (Optional, default 0) can be:
-	Select 0 - OBJECT: Target unit
+* 1 = primary weapon
-	Select 1 - NUMBER: Mode - 0 for primary weapon, 1 for secondary, 2 for handgun. Defult is 0.
+* 2 = secondary weapon
-	Select 2 - NUMBER or ARRAY: Chance to keep the current optics, in %. Default is 50.
+* 3 = handgun
-	Select 3 - NUMBER or ARRAY: Chance to keep the current side attachment, in %. Default is 50.
-	Select 4 - NUMBER or ARRAY: Chance to keep the current muzzle attachment, in %. Default is 50.
-	Select 5 - NUMBER or ARRAY: Chance to keep the current underbarrel attachment, in %. Default is 50.
-	If you use ["itemClassname",number], the function will add that attachment if it passes the check. If not, current will be removed.
+|p3= chanceOptics: [[Number]] or [[Array]] in format ["itemClass", chance] - (Optional, default 50) chance to keep optics from 0 to 100%
-	Returns:
+* if ["itemClassname", number] is used, the function will add that attachment if it passes the check. If not, the current attachment will be removed.
-	Boolean
-	Examples:
+|p4= chanceAttach: [[Number]] or [[Array]] in format ["itemClass", chance] - (Optional, default 50) chance to keep side attachments from 0 to 100%
-	_limit = [player] call BIS_fnc_limitWeaponItems;
-	_limit = [player,0,25,50,75,100] call BIS_fnc_limitWeaponItems;
-	_limit = [player,0,25,["acc_flashlight",50],75,100] call BIS_fnc_limitWeaponItems;
-	_limit = [player,2,["optic_Yorris",50]] call BIS_fnc_limitWeaponItems;
-	_limit = [player,0,["optic_lrps",100],["acc_pointer_ir",100],["muzzle_snds_B",100],["bipod_01_F_blk",100]] call BIS_fnc_limitWeaponItems;
-*/
-// Params
+|p5= chanceMuzzle: [[Number]] or [[Array]] in format ["itemClass", chance] - (Optional, default 50) chance to keep muzzle attachment from 0 to 100%
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_limitWeaponItems]]; --> |= Syntax
+|p6= chanceUnderbarrel: [[Number]] or [[Array]] in format ["itemClass",chance] - (Optional, default 50) chance to keep underbarrel attachment from 0 to 100%
-|p1= |= Parameter 1
-| |= Return value
+|r1= [[Boolean]]
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|x1= <sqf>player call BIS_fnc_limitWeaponItems;</sqf>
-____________________________________________________________________________________________
-| |= See also
+|x2= <sqf>[[player, 0, 25, 50, 75, 100]]  call BIS_fnc_limitWeaponItems;</sqf>
+|x3= <sqf>[[player, 0, ["optic_lrps", 100], ["acc_pointer_ir", 100], ["muzzle_snds_B", 100], ["bipod_01_F_blk", 100]]] call BIS_fnc_limitWeaponItems;</sqf>
+|seealso= [[BIS_fnc_limitAmmunition]] [[BIS_fnc_limitItems]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Inventory|{{uc:limitWeaponItems}}]]
-[[Category:Functions|{{uc:limitWeaponItems}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:limitWeaponItems}}]]