getUnitLoadout: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (argument is not applicable as it is a normal getter, therefore global) |
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
||
(16 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{Command| | {{Command|Comments= | ||
|game1= arma3 | |||
| [[ | |version1= 1.58 | ||
| | |||
|gr1= Unit Inventory |GROUP1= | |||
|descr= 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: | |||
<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" | |||
}; | |||
};</syntaxhighlight> | |||
{{Informative | Since {{arma3}} v1.92 an empty loadout could be obtained with <tt>[[getUnitLoadout]] ([[configFile]] >> "EmptyLoadout")</tt>}} | |||
|s1= [[getUnitLoadout]] unit | |||
|p1= unit: [[Object]] | |||
|r1= [[Array]] - [[Unit Loadout Array]] | |||
|s2= [[getUnitLoadout]] [unit, fullMagazines] | |||
|p21 = [unit, fullMagazines]: [[Array]] | |||
|p22= unit: [[Object]] | |||
|p23= fullMagazines: [[Boolean]] - [[true]] to top up used magazines | |||
|r2= [[Array]] - [[Unit Loadout Array]] | |||
|s3= [[getUnitLoadout]] name | |||
|p41= name: [[String]] - class name (see description) | |||
|r3= [[Array]] - [[Unit Loadout Array]] | |||
|s4= [[getUnitLoadout]] config | |||
|p61= config: [[Config]] - config class (see description) | |||
|r4= [[Array]] - [[Unit Loadout Array]] | |||
|x1= <code>[[getUnitLoadout]] [[player]];</code> | |||
|x2= <code>[[getUnitLoadout]] [<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> | |||
|seealso= [[setUnitLoadout]] | |||
}} | }} | ||
<h3 style='display:none'>Notes</h3> | <h3 style='display:none'>Notes</h3> | ||
Line 27: | Line 76: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
{{GameCategory|arma3|Scripting Commands}} | |||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | |||
{{GameCategory|arma3|New Scripting Commands}} |
Revision as of 00:10, 13 January 2021
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" }; };
- 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, fullMagazines]: Array
- 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