loadUniform: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Clarify what loadUniform actually returns)
m (Some wiki formatting)
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|gr1= Unit Inventory
____________________________________________________________________________________________


| Returns current percentage of mass from items stored in a uniform relative to the maximum capacity of the uniform. <br>
|descr= Returns current percentage of mass from items stored in a uniform relative to the maximum capacity of the uniform.<br>
It is equivalent to this formula:
It is equivalent to this formula:
<code>_loadUniform <nowiki>=</nowiki> massOfAllItemsInUniform / [[getContainerMaxLoad]] [[uniform]] [[player]]; </code>|DESCRIPTION=
<sqf>private _loadUniform = massOfAllItemsInUniform / getContainerMaxLoad uniform player;</sqf>
____________________________________________________________________________________________


| '''loadUniform''' unit |SYNTAX=
|s1= [[loadUniform]] unit


|p1= unit: [[Object]] |PARAMETER1=
|p1= unit: [[Object]]


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


|x1= <sqf>private _weight = loadUniform player;</sqf>


|x1= <code>_weight = [[loadUniform]] [[player]];</code>|EXAMPLE1=
|seealso= [[load]] [[loadAbs]] [[loadBackpack]] [[loadVest]] [[getMass]] [[weightRTD]] [[getContainerMaxLoad]]
 
____________________________________________________________________________________________
 
| [[load]], [[loadAbs]], [[loadBackpack]], [[loadVest]], [[getMass]], [[weightRTD]], [[getContainerMaxLoad]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:22, 13 May 2022

Hover & click on the images for description

Description

Description:
Returns current percentage of mass from items stored in a uniform relative to the maximum capacity of the uniform.
It is equivalent to this formula:
private _loadUniform = massOfAllItemsInUniform / getContainerMaxLoad uniform player;
Groups:
Unit Inventory

Syntax

Syntax:
loadUniform unit
Parameters:
unit: Object
Return Value:
Number

Examples

Example 1:
private _weight = loadUniform player;

Additional Information

See also:
load loadAbs loadBackpack 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