loadBackpack: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(added example)
m (Text replacement - "<code>([^\[]+)<\/code>" to "<sqf>$1</sqf>")
 
(61 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|gr1= Containers
____________________________________________________________________________________________


| Returns current sum of mass from items stored in a backpack. |= Description
|descr= Returns current percentage of mass from items stored in a backpack relative to the maximum capacity of the backpack.<br>
____________________________________________________________________________________________
It is equivalent to this formula:
<sqf>_loadBackpack = massOfAllItemsInBackpack / getContainerMaxLoad backpack player;</sqf>


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


|p1= unit: [[Object]] |= PARAMETER1
|p1= unit: [[Object]]


| [[Number]] |= RETURNVALUE
|r1= [[Number]]


|x1= <sqf>private _myVariable = loadBackpack myUnit;</sqf>


|x1= <code> myVariable = loadBackpack myUnit;
|seealso= [[load]] [[backpackContainer]] [[firstBackpack]] [[unitBackpack]] [[backpack]] [[backpackCargo]] [[getBackpackCargo]] [[backpackItems]] [[addBackpack]] [[addBackpackCargo]] [[removeBackpack]] [[clearBackpackCargo]] [[clearAllItemsFromBackpack]] [[backpackSpaceFor]] [[canAddItemToBackpack]] [[addItemToBackpack]] [[removeItemFromBackpack]] [[everyBackpack]] [[loadUniform]] [[loadVest]] [[getMass]] [[weightRTD]] [[getContainerMaxLoad]]
</code>|= EXAMPLE1
 
____________________________________________________________________________________________
 
| [[backpackContainer]], [[firstBackpack]], [[unitBackpack]], [[backpack]], [[backpackCargo]], [[getBackpackCargo]], [[backpackItems]], [[addBackpack]], [[addBackpackCargo]], [[addBackpackCargoGlobal]], [[removeBackpack]], [[clearBackpackCargo]], [[clearBackpackCargoGlobal]], [[clearAllItemsFromBackpack]], [[backpackSpaceFor]], [[canAddItemToBackpack]], [[addItemToBackpack]], [[removeItemFromBackpack]], [[everyBackpack]] |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}
<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:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 20:08, 13 May 2022

Hover & click on the images for description

Description

Description:
Returns current percentage of mass from items stored in a backpack relative to the maximum capacity of the backpack.
It is equivalent to this formula:
_loadBackpack = massOfAllItemsInBackpack / getContainerMaxLoad backpack player;
Groups:
Containers

Syntax

Syntax:
loadBackpack unit
Parameters:
unit: Object
Return Value:
Number

Examples

Example 1:
private _myVariable = loadBackpack myUnit;

Additional Information

See also:
load backpackContainer firstBackpack unitBackpack backpack backpackCargo getBackpackCargo backpackItems addBackpack addBackpackCargo removeBackpack clearBackpackCargo clearAllItemsFromBackpack backpackSpaceFor canAddItemToBackpack addItemToBackpack removeItemFromBackpack everyBackpack loadUniform loadVest getMass weightRTD getContainerMaxLoad

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