load: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(16 intermediate revisions by 3 users not shown)
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 in range 0..1, but can be higher after using certain scripting commands (like [[addWeaponWithAttachmentsCargoGlobal]]) which ignore load values when adding items.
<code>_loadPlayer <nowiki>=</nowiki> [[loadAbs]] [[player]] / [[getNumber]] ([[configFile]] >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");</code>
{{Feature|informative|See {{Link|#Example 2}} for load calculation.}}


|s1= [[load]] unit (since Arma 2.06 command also supports containers, ammo boxes, weapon holders, vehicle cargos)
|s1= [[load]] unit


|p1= unit: [[Object]]
|p1= unit: [[Object]] - (before {{GVI|arma3|2.08|size= 0.75}} the command did not support containers, ammo boxes, weapon holders, vehicle cargos)


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


|x1= <code>[[load]] [[player]];</code>
|x1= <sqf>load player;</sqf>


|seealso= [[loadAbs]], [[loadBackpack]], [[loadUniform]], [[loadVest]], [[getMass]], [[weightRTD]], [[getContainerMaxLoad]]
|x2= unit load calculation formula:
<sqf>private _unitLoad = loadAbs _unit / getNumber (configFile >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");</sqf>
 
|seealso= [[maxLoad]] [[loadAbs]] [[loadBackpack]] [[loadUniform]] [[loadVest]] [[getMass]] [[weightRTD]] [[getContainerMaxLoad]]
}}
}}

Latest revision as of 09:15, 28 September 2023

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