getUnitLoadout: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(alt syntax)
(configexplanation)
Line 2: Line 2:
|arma3|= Game name
|arma3|= Game name
|1.58|= Game version
|1.58|= Game version
| Returns an array with all assigned items, weapons, containers and their stored items.
| Returns an 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:
<syntaxhighlight lang=cpp>
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","HandGrenade","HandGrenade","HandGrenade"};
};</syntaxhighlight>
 
Detailed explanation of the returned array: [[Talk:getUnitLoadout]]|= Description
Detailed explanation of the returned array: [[Talk:getUnitLoadout]]|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 14: Line 25:
|p21 = [unit, fullMagazines]: [[Array]] |= Parameter 1
|p21 = [unit, fullMagazines]: [[Array]] |= Parameter 1
|p22= unit: [[Object]] |= Parameter 2
|p22= unit: [[Object]] |= Parameter 2
|p23= fullMagazines: [[Boolean]] |= Parameter 3
|p23= fullMagazines: [[Boolean]] - [[true]] to top up used magazines|= Parameter 3


|r2= [[Array]] - Array containing all inventory items |= Return value
|r2= [[Array]] - Array containing all inventory items |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
|s3= [[getUnitLoadout]] name |= Syntax
|s3= [[getUnitLoadout]] name |= Syntax
|p41= name: [[String]] - class name |= Parameter 1
|p41= name: [[String]] - class name (see description)|= Parameter 1


|r3= [[Array]] - Array containing all inventory items |= Return value
|r3= [[Array]] - Array containing all inventory items |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
|s4= [[getUnitLoadout]] config |= Syntax
|s4= [[getUnitLoadout]] config |= Syntax
|p61= config: [[Config]] - config class |= Parameter 1
|p61= config: [[Config]] - config class (see description) |= Parameter 1


|r4= [[Array]] - Array containing all inventory items |= Return value
|r4= [[Array]] - Array containing all inventory items |= Return value
Line 32: Line 43:
|x3= <code>[[getUnitLoadout]] "B_Soldier_F";</code>|=
|x3= <code>[[getUnitLoadout]] "B_Soldier_F";</code>|=
|x4= <code>[[getUnitLoadout]] ([[configFile]] >> "CfgVehicles" >> "B_Soldier_F");</code>|=
|x4= <code>[[getUnitLoadout]] ([[configFile]] >> "CfgVehicles" >> "B_Soldier_F");</code>|=
|x5= <code>[[getUnitLoadout]] ([[missionConfigFile]] >> "MyLoadout");</code>|=


| [[setUnitLoadout]]|= SEEALSO  
| [[setUnitLoadout]]|= SEEALSO  

Revision as of 16:12, 15 October 2018

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

Description

Description:
Returns an array with all assigned items, weapons, containers and their stored items. When String for class name is supplied, the command will search CfgVehicles for the given class in order to extract the loadout from config. If Config is given, it will search given config (including 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: 
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","HandGrenade","HandGrenade","HandGrenade"};
};
Detailed explanation of the returned array: Talk:getUnitLoadout
Groups:
Uncategorised

Syntax 1

Syntax:
getUnitLoadout unit
Parameters:
unit: Object
Return Value:
Array - Array containing all inventory items

Syntax 2

Syntax:
getUnitLoadout [unit, fullMagazines]
Parameters:
[unit, fullMagazines]: Array
unit: Object
fullMagazines: Boolean - true to top up used magazines
Return Value:
Array - Array containing all inventory items

Syntax 3

Syntax:
getUnitLoadout name
Parameters:
name: String - class name (see description)
Return Value:
Array - Array containing all inventory items

Syntax 4

Syntax:
getUnitLoadout config
Parameters:
config: Config - config class (see description)
Return Value:
Array - Array containing all inventory items

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

Bottom Section

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=getUnitLoadout&oldid=109842"