addBackpackGlobal: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(81 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma 3 |= Game name
|game1= arma3
|arg= global|=
|version1= 1.32
|eff= global|=
|1.32|= Game version
____________________________________________________________________________________________


| Adds a backpack to a unit (even non-local).<br><br>
|arg= global
{{Warning | Beware, the backpack added with this command will be created on the PC [[local]] to the unit you are adding it to, even if executed on the server. Because of this, if non-local unit is the target and one tries to immediately access added backpack, the backpack returned will be [[objNull | Null]]. When adding backpack dynamically to a remote unit, wait until backpack is added (See Example 2)}}  |DESCRIPTION=
____________________________________________________________________________________________


| unit '''addBackpackGlobal''' backpack|SYNTAX=
|eff= global


|p1= unit: [[Object]] - soldier |PARAMETER1=
|gr1= Unit Inventory
|p2= backpack: [[String]] - backpack class name |PARAMETER2=


| [[Nothing]] |RETURNVALUE=
|descr= Adds a backpack to a unit - global variant of [[addBackpack]].
____________________________________________________________________________________________
{{Feature|warning|
 
The backpack added with this command will be created on the PC [[Multiplayer Scripting#Locality|local]] to the unit you are adding it to, even if executed on the server.
|x1= <code>[[player]] [[addBackpackGlobal]] "B_AssaultPack_khk";</code> |EXAMPLE1=
Because of this, if non-local unit is the target and one tries to immediately access added backpack, the backpack returned will be [[objNull|null]].
When adding backpack dynamically to a remote unit, [[waitUntil|wait until]] the backpack is added (See {{Link|#Example 2}}).
}}


|x2= <code>_unit [[spawn]]
|s1= unit [[addBackpackGlobal]] backpack
{
[[if]] (![[isNull]] [[backpackContainer]] [[_this]]) [[then]]
{
[[removeBackpackGlobal]] [[_this]];
[[waitUntil]] { [[isNull]] [[backpackContainer]] [[_this]] };
};
[[_this]] [[addBackpackGlobal]] "B_AssaultPack_khk";
[[waitUntil]] { ![[isNull]] [[backpackContainer]] [[_this]] };
[[backpackContainer]] [[_this]] [[addMagazineCargoGlobal]] ["30Rnd_556x45_Stanag",5];
};</code> |EXAMPLE2=


____________________________________________________________________________________________
|p1= unit: [[Object]] - soldier


| [[addBackpack]], [[backpackContainer]], [[firstBackpack]], [[unitBackpack]], [[backpack]], [[backpackCargo]], [[getBackpackCargo]], [[backpackItems]], [[addBackpackCargo]], [[addBackpackCargoGlobal]], [[removeBackpack]], [[clearBackpackCargo]], [[clearBackpackCargoGlobal]], [[clearAllItemsFromBackpack]], [[loadBackpack]], [[backpackSpaceFor]], [[canAddItemToBackpack]], [[addItemToBackpack]], [[removeItemFromBackpack]], [[everyBackpack]]|SEEALSO=
|p2= backpack: [[String]] - backpack class name


}}
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>player addBackpackGlobal "B_AssaultPack_khk";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>
_unit spawn
{
if (not isNull backpackContainer _this) then
{
removeBackpackGlobal _this;
waitUntil { sleep 0.01; isNull backpackContainer _this };
};


_this addBackpackGlobal "B_AssaultPack_khk";
waitUntil { sleep 0.01; not isNull backpackContainer _this };
backpackContainer _this addMagazineCargoGlobal ["30Rnd_556x45_Stanag", 5];
};
</sqf>


[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|seealso= [[addBackpack]] [[backpackContainer]] [[firstBackpack]] [[unitBackpack]] [[backpack]] [[backpackCargo]] [[getBackpackCargo]] [[backpackItems]] [[addBackpackCargo]] [[addBackpackCargoGlobal]] [[removeBackpack]] [[clearBackpackCargo]] [[clearBackpackCargoGlobal]] [[clearAllItemsFromBackpack]] [[loadBackpack]] [[backpackSpaceFor]] [[canAddItemToBackpack]] [[addItemToBackpack]] [[removeItemFromBackpack]] [[everyBackpack]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
}}

Latest revision as of 21:35, 2 September 2024

Hover & click on the images for description

Description

Description:
Adds a backpack to a unit - global variant of addBackpack.
The backpack added with this command will be created on the PC local to the unit you are adding it to, even if executed on the server.

Because of this, if non-local unit is the target and one tries to immediately access added backpack, the backpack returned will be null.

When adding backpack dynamically to a remote unit, wait until the backpack is added (See Example 2).
Groups:
Unit Inventory

Syntax

Syntax:
unit addBackpackGlobal backpack
Parameters:
unit: Object - soldier
backpack: String - backpack class name
Return Value:
Nothing

Examples

Example 1:
player addBackpackGlobal "B_AssaultPack_khk";
Example 2:

Additional Information

See also:
addBackpack backpackContainer firstBackpack unitBackpack backpack backpackCargo getBackpackCargo backpackItems addBackpackCargo addBackpackCargoGlobal removeBackpack clearBackpackCargo clearBackpackCargoGlobal clearAllItemsFromBackpack loadBackpack backpackSpaceFor canAddItemToBackpack 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