getUnitLoadout: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Remove syntaxhighlight spoiler hack)
 
(36 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
|arma3|= Game name
 
|1.58|= Game version
|game1= arma3
| Returns a [[Unit Loadout Array]] with all assigned items, weapons, containers and their stored items. When [[String]] for class name is supplied, the command will search <tt>CfgVehicles</tt> for the given class in order to extract the loadout from config. If [[Config]] is given, it will search given config (including [[missionConfigFile | mission config]]) for the loadout information. In either case, the config should contain the following entries, which is standard for any unit class, for example:
|version1= 1.58
<syntaxhighlight lang=cpp>
 
|gr1= Unit Inventory
 
|descr= Returns a '''[[Unit Loadout Array]]''' with all assigned items, weapons, containers and their stored items.
 
{{Feature|informative|
The config should contain the following standard entries: <spoiler>
<syntaxhighlight lang="cpp">
class MyLoadout
class MyLoadout
{
{
uniformClass = "U_B_CombatUniform_mcam";
uniformClass = "U_B_CombatUniform_mcam";
backpack = "B_AssaultPack_mcamo";
backpack = "B_AssaultPack_mcamo";
linkedItems[] = {"V_PlateCarrier1_rgr","H_HelmetB","ItemCompass","ItemWatch","ItemRadio","NVGoggles"};
linkedItems[] = { "V_PlateCarrier1_rgr", "H_HelmetB", "ItemCompass", "ItemWatch", "ItemRadio", "NVGoggles" };
weapons[] = {"arifle_MX_ACO_pointer_F","hgun_P07_F"};
weapons[] = { "arifle_MX_ACO_pointer_F", "hgun_P07_F" };
items[] = {"FirstAidKit","FirstAidKit","FirstAidKit"};
items[] = { "FirstAidKit", "FirstAidKit", "FirstAidKit" };
magazines[] = {"30Rnd_65x39_caseless_mag","16Rnd_9x21_Mag","SmokeShell","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade","HandGrenade"};
magazines[] = {
};</syntaxhighlight>
"30Rnd_65x39_caseless_mag", "16Rnd_9x21_Mag",
"SmokeShell",
"HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade",
"HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade",
"HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade"
};
};
</syntaxhighlight>
</spoiler>
}}
 
|s1= [[getUnitLoadout]] unit
 
|p1= unit: [[Object]]
 
|r1= [[Array]] format [[Unit Loadout Array]]
 
|s2= [[getUnitLoadout]] [unit, fullMagazines]
 
|p21= unit: [[Object]]
 
|p22= fullMagazines: [[Boolean]] - [[true]] to top up used magazines
 
|r2= [[Array]] format [[Unit Loadout Array]]
 
|s3= [[getUnitLoadout]] name
 
|p41= name: [[String]] - {{hl|CfgVehicles}} classname from which to extract the loadout


|= Description
|r3= [[Array]] format [[Unit Loadout Array]]
____________________________________________________________________________________________


| [[getUnitLoadout]] unit |= Syntax
|s4= [[getUnitLoadout]] config
|p1= unit: [[Object]] |= Parameter 1


| [[Array]] - [[Unit Loadout Array]] |= Return Value
|p61= config: [[Config]] - loadout config class
____________________________________________________________________________________________
|s2= [[getUnitLoadout]] [unit, fullMagazines] |= Syntax
|p21 = [unit, fullMagazines]: [[Array]] |= Parameter 1
|p22= unit: [[Object]] |= Parameter 2
|p23= fullMagazines: [[Boolean]] - [[true]] to top up used magazines|= Parameter 3


|r2= [[Array]] - [[Unit Loadout Array]] |= Return value
|r4= [[Array]] format [[Unit Loadout Array]]
____________________________________________________________________________________________
|s3= [[getUnitLoadout]] name |= Syntax
|p41= name: [[String]] - class name (see description)|= Parameter 1


|r3= [[Array]] - [[Unit Loadout Array]] |= Return value
|x1= <sqf>getUnitLoadout player;</sqf>
____________________________________________________________________________________________
|s4= [[getUnitLoadout]] config |= Syntax
|p61= config: [[Config]] - config class (see description) |= Parameter 1


|r4= [[Array]] - [[Unit Loadout Array]] |= Return value
|x2= <sqf>getUnitLoadout [player, true];</sqf>
____________________________________________________________________________________________
|x1= <code>[[getUnitLoadout]] [[player]];</code>|=
|x2= <code>[[getUnitLoadout]] <nowiki>[</nowiki>[[player]], [[true]]];</code>|=
|x3= <code>[[getUnitLoadout]] "B_Soldier_F";</code>|=
|x4= <code>[[getUnitLoadout]] ([[configFile]] >> "CfgVehicles" >> "B_Soldier_F");</code>|=
|x5= <code>[[getUnitLoadout]] ([[missionConfigFile]] >> "MyLoadout");</code>|=


| [[setUnitLoadout]]|SEEALSO=  
|x3= <sqf>getUnitLoadout "B_Soldier_F";</sqf>
|  |MPBEHAVIOUR=
}}


<h3 style='display:none'>Bottom Section</h3>
|x4= <sqf>getUnitLoadout (configFile >> "CfgVehicles" >> "B_Soldier_F");</sqf>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]


<h3 style='display:none'>Notes</h3>
|x5= <sqf>getUnitLoadout (missionConfigFile >> "MyLoadout");</sqf>
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- END Note Section -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[setUnitLoadout]]
}}

Latest revision as of 13:44, 23 June 2023

Arma 3 logo black.png1.58
Hover & click on the images for description

Description

Description:
Returns a Unit Loadout Array with all assigned items, weapons, containers and their stored items.
ⓘ
The config should contain the following standard entries: 
class MyLoadout
{
	uniformClass = "U_B_CombatUniform_mcam";
	backpack = "B_AssaultPack_mcamo";
	linkedItems[] = { "V_PlateCarrier1_rgr", "H_HelmetB", "ItemCompass", "ItemWatch", "ItemRadio", "NVGoggles" };
	weapons[] = { "arifle_MX_ACO_pointer_F", "hgun_P07_F" };
	items[] = { "FirstAidKit", "FirstAidKit", "FirstAidKit" };
	magazines[] = {
		"30Rnd_65x39_caseless_mag", "16Rnd_9x21_Mag",
		"SmokeShell",
		"HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade",
		"HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade",
		"HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade", "HandGrenade"
	};
};
Groups:
Unit Inventory

Syntax 1

Syntax:
getUnitLoadout unit
Parameters:
unit: Object
Return Value:
Array format Unit Loadout Array

Syntax 2

Syntax:
getUnitLoadout [unit, fullMagazines]
Parameters:
unit: Object
fullMagazines: Boolean - true to top up used magazines
Return Value:
Array format Unit Loadout Array

Syntax 3

Syntax:
getUnitLoadout name
Parameters:
name: String - CfgVehicles classname from which to extract the loadout
Return Value:
Array format Unit Loadout Array

Syntax 4

Syntax:
getUnitLoadout config
Parameters:
config: Config - loadout config class
Return Value:
Array format Unit Loadout Array

Examples

Example 1:
getUnitLoadout player;
Example 2:
getUnitLoadout [player, true];
Example 3:
getUnitLoadout "B_Soldier_F";
Example 4:
getUnitLoadout (configFile >> "CfgVehicles" >> "B_Soldier_F");
Example 5:
getUnitLoadout (missionConfigFile >> "MyLoadout");

Additional Information

See also:
setUnitLoadout

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=getUnitLoadout&oldid=341789"