load: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
(edited description to state outright that the output is a percentage)
Line 6: Line 6:
|gr1= Unit Inventory
|gr1= Unit Inventory


|descr= Returns current sum of mass from items stored in all unit's containers. Load is calculated by the following formula:
|descr= 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.
<br>Player load is calculated by the following formula:
<code>_loadPlayer <nowiki>=</nowiki> [[loadAbs]] [[player]] / [[getNumber]] ([[configFile]] >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");</code>
<code>_loadPlayer <nowiki>=</nowiki> [[loadAbs]] [[player]] / [[getNumber]] ([[configFile]] >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");</code>


|s1= [[load]] unit
|s1= [[load]] unit

Revision as of 16:12, 3 April 2022

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