load

From Bohemia Interactive Community
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
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 Arma 3 logo black.png2.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