getUnitLoadout

1.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. 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.

ⓘ

The config should contain the following entries, which is standard for any unit class:Show text

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 - Unit Loadout Array

Syntax 2

Syntax:

getUnitLoadout [unit, fullMagazines]

Parameters:

unit: Object

fullMagazines: Boolean - true to top up used magazines

Return Value:

Array - Unit Loadout Array

Syntax 3

Syntax:

getUnitLoadout name

Parameters:

name: String - class name (see description)

Return Value:

Array - Unit Loadout Array

Syntax 4

Syntax:

getUnitLoadout config

Parameters:

config: Config - config class (see description)

Return Value:

Array - 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