load: Difference between revisions

Latest revision as of 09:15, 28 September 2023

0.50

Hover & click on the images for description

Description

Description:: Returns the percentage of fullness of a unit's cargo. Output is usually in range 0..1, but can be higher after using certain scripting commands (like addWeaponWithAttachmentsCargoGlobal) which ignore load values when adding items.
ⓘ
See Example 2 for load calculation.
Groups:: Unit Inventory

Syntax

Syntax:: load unit
Parameters:: unit: Object - (before 2.08 the command did not support containers, ammo boxes, weapon holders, vehicle cargos)
Return Value:: Number

Examples

Example 1:: load player;
Example 2:: unit load calculation formula:
private _unitLoad = loadAbs _unit / getNumber (configFile >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");

Additional Information

See also:: maxLoad loadAbs loadBackpack 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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 0.50
-|0.50|= Game version
+|gr1= Unit Inventory
-____________________________________________________________________________________________
-| Returns current sum of mass from items stored in all unit's containers.  |= Description
+|descr= Returns the percentage of fullness of a unit's cargo. Output is usually in range 0..1, but can be higher after using certain scripting commands (like [[addWeaponWithAttachmentsCargoGlobal]]) which ignore load values when adding items.
-____________________________________________________________________________________________
+{{Feature|informative|See {{Link|#Example 2}} for load calculation.}}
-| '''load''' unit |= Syntax
+|s1= [[load]] unit
-|p1= unit: [[Object]]  |= PARAMETER1
+|p1= unit: [[Object]] - (before {{GVI|arma3|2.08|size= 0.75}} the command did not support containers, ammo boxes, weapon holders, vehicle cargos)
-| [[Number]] |= RETURNVALUE
+|r1= [[Number]]
+|x1= <sqf>load player;</sqf>
-|x1= <code>
+|x2= unit load calculation formula:
-</code>|= EXAMPLE1
+<sqf>private _unitLoad = loadAbs _unit / getNumber (configFile >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");</sqf>
-____________________________________________________________________________________________
+|seealso= [[maxLoad]] [[loadAbs]] [[loadBackpack]] [[loadUniform]] [[loadVest]] [[getMass]] [[weightRTD]] [[getContainerMaxLoad]]
-| [[loadAbs]], [[loadBackpack]], [[loadUniform]], [[loadVest]], [[getMass]] |= 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}}}}]]