getUnitLoadout

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Arma 3 version 1.58
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.58

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. 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"};
};

Syntax

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

Alternative Syntax

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

Alternative Syntax 2

Syntax:
getUnitLoadout name
Parameters:
name: String - class name (see description)
Return Value:
Array - Unit Loadout Array

Alternative Syntax 3

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

Multiplayer:
-
See also:
setUnitLoadout

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Bottom Section

Notes

Bottom Section