BIS fnc limitWeaponItems: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Inventory |GROUP1=
|gr1 = Inventory


| Keeps or remove unit's weapon attachments based on probability user sets. Apply for primary, secondary or handgun weapon separately.|Description=
| Keeps or remove unit's weapon attachments based on probability user sets. Apply for primary, secondary or handgun weapon separately.


| [unit,mode,chanceOptics,chanceAttach,chanceMuzzle,chanceUnderbarrel] call [[BIS_fnc_limitWeaponItems]] |Syntax=
| [unit,mode,chanceOptics,chanceAttach,chanceMuzzle,chanceUnderbarrel] call [[BIS_fnc_limitWeaponItems]]




|p1= unit: [[Object]] - Target unit|Parameter 1=
|p1= unit: [[Object]] - Target unit


|p2= mode: [[Number]] - (Optional, default 0) Can be:
|p2= mode: [[Number]] - (Optional, default 0) Can be:
*1 = primary weapon
*1 = primary weapon
*2 = secondary weapon
*2 = secondary weapon
*3 = handgun|Parameter 2=
*3 = handgun


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


*If you use ["itemClassname",number], the function will add that attachment if it passes the check. If not, current will be removed.|Parameter 3=
*If you use ["itemClassname",number], the function will add that attachment if it passes the check. If not, current will be removed.


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


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


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


| [[Boolean]] |Return value=
| [[Boolean]]


|x1= <code>[[player]] [[call]] [[BIS_fnc_limitWeaponItems]];</code>|Example 1=
|x1= <code>[[player]] [[call]] [[BIS_fnc_limitWeaponItems]];</code>


|x2= <code>[ [<nowiki/>[[player]], 0, 25, 50, 75, 100 ] ]  [[call]] [[BIS_fnc_limitWeaponItems]];</code>|Example 2=
|x2= <code>[ [<nowiki/>[[player]], 0, 25, 50, 75, 100 ] ]  [[call]] [[BIS_fnc_limitWeaponItems]];</code>


|x3= <code>[ [<nowiki/>[[player]], 0, ["optic_lrps",100], ["acc_pointer_ir",100], ["muzzle_snds_B",100], ["bipod_01_F_blk",100] ] ]  [[call]] [[BIS_fnc_limitWeaponItems]];</code>|Example 3=
|x3= <code>[ [<nowiki/>[[player]], 0, ["optic_lrps",100], ["acc_pointer_ir",100], ["muzzle_snds_B",100], ["bipod_01_F_blk",100] ] ]  [[call]] [[BIS_fnc_limitWeaponItems]];</code>


| [[BIS_fnc_limitAmmunition]], [[BIS_fnc_limitItems]] |See also=
| [[BIS_fnc_limitAmmunition]], [[BIS_fnc_limitItems]]
}}
}}


Revision as of 23:09, 17 January 2021

Arma 3 logo black.png1.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 you use ["itemClassname",number], the function will add that attachment if it passes the check. If not, current 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_limitAmmunitionBIS_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


Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_limitWeaponItems&oldid=203094"