getContainerMaxLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.62


|1.62|Game version=
|gr1= Unit Inventory


|gr1= Unit Inventory |GROUP1=
|descr= Returns max load value of given uniform, vest or backpack container. For other types of containers, use [[maxLoad]] command
____________________________________________________________________________________________


| Returns max load value of given container. Currently works only with uniform, vest and backpack classes.  |DESCRIPTION=
|s1= [[getContainerMaxLoad]] containerClass
____________________________________________________________________________________________


| '''getContainerMaxLoad''' containerClass |SYNTAX=
|p1= containerClass: [[String]] - uniform, vest or backpack class


|p1= containerClass: [[String]] - uniform, vest or backpack class  |PARAMETER1=
|r1= [[Number]] - load value, -1 if not available.


| [[Number]] - load value, -1 if not available. |RETURNVALUE=  
|x1= <sqf>
_maxLoadUniform = getContainerMaxLoad uniform player;
_maxLoadVest = getContainerMaxLoad vest player;
_maxLoadBackpack = getContainerMaxLoad backpack player;
</sqf>


|x1= <code>_maxLoadUniform = [[getContainerMaxLoad]] [[uniform]] [[player]];
|seealso= [[load]] [[loadAbs]] [[loadUniform]] [[loadBackpack]] [[loadVest]] [[getMass]] [[weightRTD]]
_maxLoadVest = [[getContainerMaxLoad]] [[vest]] [[player]];
_maxLoadBackpack = [[getContainerMaxLoad]] [[backpack]] [[player]];</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[load]], [[loadAbs]], [[loadUniform]], [[loadBackpack]], [[loadVest]], [[getMass]], [[weightRTD]] |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>
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for description

Description

Description:
Returns max load value of given uniform, vest or backpack container. For other types of containers, use maxLoad command
Groups:
Unit Inventory

Syntax

Syntax:
getContainerMaxLoad containerClass
Parameters:
containerClass: String - uniform, vest or backpack class
Return Value:
Number - load value, -1 if not available.

Examples

Example 1:
_maxLoadUniform = getContainerMaxLoad uniform player; _maxLoadVest = getContainerMaxLoad vest player; _maxLoadBackpack = getContainerMaxLoad backpack player;

Additional Information

See also:
load loadAbs loadUniform loadBackpack loadVest getMass weightRTD

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