load

From Bohemia Interactive Community
Revision as of 17:12, 3 April 2022 by DreadedEntity (talk | contribs) (edited description to state outright that the output is a percentage)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Returns the percentage of fullness of a unit's cargo. Output is usually between 0 and 1, but can be higher after using certain scripting commands which ignore load values when adding items.
Player load is calculated by the following formula: _loadPlayer = loadAbs player / getNumber (configFile >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");
Groups:
Unit Inventory

Syntax

Syntax:
load unit
Parameters:
unit: Object (since Arma 2.08 command also supports containers, ammo boxes, weapon holders, vehicle cargos)
Return Value:
Number

Examples

Example 1:
load player;

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