backpackContainer: Difference between revisions

From Bohemia Interactive Community
m (Bot: Replacing category Scripting Commands Arma 3 with Arma 3: Scripting Commands)
m (Some wiki formatting)
 
(66 intermediate revisions by 3 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
____________________________________________________________________________________________


| Returns a cargo container of a unit's backpack. |= Description
|descr= Returns a cargo container of a unit's backpack.
____________________________________________________________________________________________


| '''backpackContainer''' unit |= Syntax
|s1= [[backpackContainer]] unit


|p1= unit: [[Object]] - a soldier |= PARAMETER1
|p1= unit: [[Object]] - a soldier


| [[Object]] - cargo container or <NULL-object>  |= RETURNVALUE
|r1= [[Object]] - cargo container or [[objNull]]


|x1= <sqf>hint str backpackContainer player; // 1a5f7900# 163944: backpack_fast.p3d</sqf>


|x1= <code>[[hint]] [[str]] [[backpackContainer]] [[player]]; //1a5f7900# 163944: backpack_fast.p3d
|x2= <sqf>
</code>|= EXAMPLE1
hint str getMagazineCargo backpackContainer player;
 
/*
|x2= <code>[[hint]] [[str]] [[getMagazineCargo]] [[backpackContainer]] [[player]];</code>
returns e.g
 
<pre>[
[
[
"APERSBoundingMine_Range_Mag",
[
"ClaymoreDirectionalMine_Remote_Mag",
"APERSBoundingMine_Range_Mag",
"SLAMDirectionalMine_Wire_Mag",
"ClaymoreDirectionalMine_Remote_Mag",
"DemoCharge_Remote_Mag"
"SLAMDirectionalMine_Wire_Mag",
],[
"DemoCharge_Remote_Mag"
3,
],[
2,
3,
2,
2,
1
2,
1
]
]
]
]</pre>|= EXAMPLE2
*/
</sqf>


|x3= <code>([[backpackContainer]] [[player]]) [[addWeaponCargoGlobal]] [ [[weapons]] [[player]] [[select]] 0,1];</code>|= EXAMPLE1
|x3= <sqf>(backpackContainer player) addWeaponCargoGlobal [weapons player select 0, 1];</sqf>
____________________________________________________________________________________________


| [[firstBackpack]], [[unitBackpack]], [[backpack]], [[backpackCargo]], [[getBackpackCargo]], [[backpackItems]], [[addBackpack]], [[addBackpackCargo]], [[addBackpackCargoGlobal]], [[removeBackpack]], [[clearBackpackCargo]], [[clearBackpackCargoGlobal]], [[clearAllItemsFromBackpack]], [[loadBackpack]], [[backpackSpaceFor]], [[canAddItemToBackpack]], [[addItemToBackpack]], [[removeItemFromBackpack]], [[everyBackpack]], [[uniformContainer]], [[vestContainer]], [[everyContainer]] |= SEEALSO
|seealso= [[firstBackpack]] [[unitBackpack]] [[backpack]] [[backpackCargo]] [[getBackpackCargo]] [[backpackItems]] [[addBackpack]] [[addBackpackCargo]] [[addBackpackCargoGlobal]] [[removeBackpack]] [[clearBackpackCargo]] [[clearBackpackCargoGlobal]] [[clearAllItemsFromBackpack]] [[loadBackpack]] [[backpackSpaceFor]] [[canAddItemToBackpack]] [[addItemToBackpack]] [[removeItemFromBackpack]] [[everyBackpack]] [[uniformContainer]] [[vestContainer]] [[everyContainer]]
}}


| |= MPBEHAVIOUR
{{Note
____________________________________________________________________________________________
|user= ffur2007slx2_5
|timestamp= 20140429151900
|text= In {{arma3}} ver 1.16, we can use either [[backpackContainer]] or [[unitBackpack]] at present since both of them enjoy same operand type and return value.
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on Apr 29, 2014 - 15:19
<dt class="note">'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''
<dd class="note">
In ArmA3 ver 1.16, we can use either [[backpackContainer]] or [[unitBackpack]] at present since both of them enjoy same operand type and return value.
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: Scripting Commands]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 14:06, 13 May 2022

Arma 3 logo black.png 1.04
Hover & click on the images for description

Description

Description:
Returns a cargo container of a unit's backpack.
Groups:
Containers

Syntax

Syntax:
backpackContainer unit
Parameters:
unit: Object - a soldier
Return Value:
Object - cargo container or objNull

Examples

Example 1:
hint str backpackContainer player; // 1a5f7900# 163944: backpack_fast.p3d
Example 2:
hint str getMagazineCargo backpackContainer player; /* returns e.g [ [ "APERSBoundingMine_Range_Mag", "ClaymoreDirectionalMine_Remote_Mag", "SLAMDirectionalMine_Wire_Mag", "DemoCharge_Remote_Mag" ],[ 3, 2, 2, 1 ] ] */
Example 3:
(backpackContainer player) addWeaponCargoGlobal [weapons player select 0, 1];

Additional Information

See also:
firstBackpack unitBackpack backpack backpackCargo getBackpackCargo backpackItems addBackpack addBackpackCargo addBackpackCargoGlobal removeBackpack clearBackpackCargo clearBackpackCargoGlobal clearAllItemsFromBackpack loadBackpack backpackSpaceFor canAddItemToBackpack addItemToBackpack removeItemFromBackpack everyBackpack uniformContainer vestContainer everyContainer

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
ffur2007slx2_5 - c
Posted on Apr 29, 2014 - 15:19 (UTC)
In Arma 3 ver 1.16, we can use either backpackContainer or unitBackpack at present since both of them enjoy same operand type and return value.
Retrieved from "https://community.bistudio.com/wiki?title=backpackContainer&oldid=321069"