canAddItemToBackpack: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
(Added potential warning message: bad vehicle type if empty string is passed)
(72 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.04


|1.04|Game version=
|gr1= Containers
____________________________________________________________________________________________


| Checks if given object can be stored into soldier's backpack. |DESCRIPTION=
|descr= Checks if given object can be stored into soldier's backpack.
____________________________________________________________________________________________


| unit '''canAddItemToBackpack''' item |SYNTAX=
{{Feature|important|
Avoid passing an empty string <sqf inline>""</sqf> to this command as it will create a warning dialog:
[[File:a3 warning badvehicletype.jpg|none|400px|alt=Warning Message: Bad vehicle type|Warning Message: Bad vehicle type]]
This message will show once per mission restart.
}}
 
|s1= unit [[canAddItemToBackpack]] item
 
|p1= unit: [[Object]]


|p1= unit: [[Object]] |PARAMETER1=
|p2= item: [[String]]
|p2= item: [[String]] |PARAMETER2=
| [[Boolean]] |RETURNVALUE=


| s2 =unit '''canAddItemToBackpack''' [item, count]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.55.133607'') |SYNTAX=
|r1= [[Boolean]]


|p21= unit: [[Object]] |PARAMETER1=
|s2= unit [[canAddItemToBackpack]] [item, count, ignoreSoldierMaxLoad]
|p22= [item, count]: [[Array]] |PARAMETER1=
|p23= item: [[String]] |PARAMETER2=
|p24= count: [[Number]]  |PARAMETER1=


| r2= [[Boolean]] |RETURNVALUE=  
|s2since= arma3 1.56


|x1= <code>_item = "HandGrenade";
|p21= unit: [[Object]]
_fits = [[player]] [[canAddItemToBackpack]] _item;
[[if]] (_fits) [[then]] {
[[player]] [[addItemToBackpack]] _item;
} [[else]] {
[[hint]] "no room!";
};</code>|EXAMPLE1=


____________________________________________________________________________________________
|p22= item: [[String]]


| [[canAdd]], [[canAddItemToUniform]], [[canAddItemToVest]], [[backpackContainer]], [[firstBackpack]], [[unitBackpack]], [[backpack]], [[backpackCargo]], [[getBackpackCargo]], [[backpackItems]], [[addBackpack]], [[addBackpackCargo]], [[addBackpackCargoGlobal]], [[removeBackpack]], [[clearBackpackCargo]], [[clearBackpackCargoGlobal]], [[clearAllItemsFromBackpack]], [[loadBackpack]], [[backpackSpaceFor]], [[addItemToBackpack]], [[removeItemFromBackpack]], [[everyBackpack]] |SEEALSO=
|p23= count: [[Number]]


| |MPBEHAVIOUR=  
|p24= ignoreSoldierMaxLoad: [[Boolean]] - (Optional, default [[false]]) [[true]] to ignore 'soldierMaxLoad' param, container [[maxLoad]] is still counted.
____________________________________________________________________________________________
|p24since= arma3 2.18
}}
 
|r2= [[Boolean]]


<h3 style='display:none'>Notes</h3>
|x1= <sqf>if (player canAddItemToBackpack "HandGrenade") then { player addItemToBackpack _item } else { hint "no room!" };</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[canAdd]] [[canAddItemToUniform]] [[canAddItemToVest]] [[backpackContainer]] [[firstBackpack]] [[unitBackpack]] [[backpack]] [[backpackCargo]] [[getBackpackCargo]] [[backpackItems]] [[addBackpack]] [[addBackpackCargo]] [[addBackpackCargoGlobal]] [[removeBackpack]] [[clearBackpackCargo]] [[clearBackpackCargoGlobal]] [[clearAllItemsFromBackpack]] [[loadBackpack]] [[backpackSpaceFor]] [[addItemToBackpack]] [[removeItemFromBackpack]] [[everyBackpack]]
</dl>
}}


<h3 style='display:none'>Bottom Section</h3>
{{Note
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
|user= AgentRev
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|timestamp= 20220329045658
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|text= This command is very unreliable, along with all other [[canAdd]] commands. For example, in the inventory screen, an empty {{hl|"B_Bergen_dgtl_F"}} backpack can fit a total of 30 {{hl|"5Rnd_127x108_APDS_Mag"}} mags. However, <sqf inline>player canAddItemToBackpack "5Rnd_127x108_APDS_Mag"</sqf> starts returning [[false]] once there are 17 in the backpack. Furthermore, if the player has equipped an empty PCML launcher (without any missile in his inventory), the command starts returning [[false]] once there are only 11, despite the fact that the launcher has no effect on backpack space...<br>
I wrote a function almost 9 years ago to bypass this (surprisingly still existing) bug. You can check it {{Link|https://github.com/A3Wasteland/ArmA3_Wasteland.Altis/blob/dev/client/functions/fn_fitsInventory.sqf|here}}, with a usage example {{Link|https://github.com/A3Wasteland/ArmA3_Wasteland.Altis/blob/dc41623f154d6c5be683374784aba201a0628e60/client/functions/addWeaponInventory.sqf#L18-L20|here}}.
}}

Revision as of 17:29, 25 May 2024

Arma 3 logo black.png1.04
Hover & click on the images for description

Description

Description:
Checks if given object can be stored into soldier's backpack.
⚠
Avoid passing an empty string "" to this command as it will create a warning dialog:
Warning Message: Bad vehicle type
This message will show once per mission restart.
Groups:
Containers

Syntax

Syntax:
unit canAddItemToBackpack item
Parameters:
unit: Object
item: String
Return Value:
Boolean

Alternative Syntax

Syntax:
unit canAddItemToBackpack [item, count, ignoreSoldierMaxLoad]
Parameters:
unit: Object
item: String
count: Number
since Arma 3 logo black.png2.18
ignoreSoldierMaxLoad: Boolean - (Optional, default false) true to ignore 'soldierMaxLoad' param, container maxLoad is still counted.
Return Value:
Boolean

Examples

Example 1:
if (player canAddItemToBackpack "HandGrenade") then { player addItemToBackpack _item } else { hint "no room!" };

Additional Information

See also:
canAdd canAddItemToUniform canAddItemToVest backpackContainer firstBackpack unitBackpack backpack backpackCargo getBackpackCargo backpackItems addBackpack addBackpackCargo addBackpackCargoGlobal removeBackpack clearBackpackCargo clearBackpackCargoGlobal clearAllItemsFromBackpack loadBackpack backpackSpaceFor addItemToBackpack removeItemFromBackpack everyBackpack

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
AgentRev - c
Posted on Mar 29, 2022 - 04:56 (UTC)
This command is very unreliable, along with all other canAdd commands. For example, in the inventory screen, an empty "B_Bergen_dgtl_F" backpack can fit a total of 30 "5Rnd_127x108_APDS_Mag" mags. However, player canAddItemToBackpack "5Rnd_127x108_APDS_Mag" starts returning false once there are 17 in the backpack. Furthermore, if the player has equipped an empty PCML launcher (without any missile in his inventory), the command starts returning false once there are only 11, despite the fact that the launcher has no effect on backpack space...
I wrote a function almost 9 years ago to bypass this (surprisingly still existing) bug. You can check it here, with a usage example here.
Retrieved from "https://community.bistudio.com/wiki?title=canAddItemToBackpack&oldid=364688"