load: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
Line 6: Line 6:
|gr1= Unit Inventory
|gr1= Unit Inventory


|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.
|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.
<br>Player load is calculated by the following formula:
{{Feature|informative|See {{HashLink|#Example 2}} for load calculation.}}
<code>_loadPlayer <nowiki>=</nowiki> [[loadAbs]] [[player]] / [[getNumber]] ([[configFile]] >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");</code>
 


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


|p1= unit: [[Object]] (since Arma 2.08 command also supports containers, ammo boxes, weapon holders, vehicle cargos)
|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>
 
|x2= unit load calculation formula:
<sqf>private _unitLoad = loadAbs _unit / getNumber (configFile >> "CfgInventoryGlobalVariable" >> "maxSoldierLoad");</sqf>


|seealso= [[maxLoad]] [[loadAbs]] [[loadBackpack]] [[loadUniform]] [[loadVest]] [[getMass]] [[weightRTD]] [[getContainerMaxLoad]]
|seealso= [[maxLoad]] [[loadAbs]] [[loadBackpack]] [[loadUniform]] [[loadVest]] [[getMass]] [[weightRTD]] [[getContainerMaxLoad]]
}}
{{subst:Preload/Note|1=
This command outputs values between 0 and 1, but can be higher through use of commands like [[addWeaponWithAttachmentsCargo]]:
<code>(vehicle player) addWeaponWithAttachmentsCargoGlobal [["arifle_MX_F","","","",[],[],""],200];</code>
}}
}}

Revision as of 17:35, 3 April 2022

Arma 3 logo black.png0.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 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
Retrieved from "https://community.bistudio.com/wiki?title=load&oldid=308821"