Reference Forum

• News
• Introduction
1. How to Use These Docs
2. First Steps
3. External Resources
• Overview
1. Case Sensitivity and Conventions
2. Event Handling
3. Error Handling
• Data Types
• Functions
• Wrappers
• Selectors
• Tables

ScenEdit_SetLoadout (table)

This function Sets the loadout for a aircraft unit

Parameters

• table {} of
  • unitname = string Unit description/name or GUID to update. Can use 'UnitX' here if in an Event Action
  • LoadoutID = number The ID of the new loadout; 0 = use the current loadout
  • TimeToReady_Minutes = number How many minutes until the loadout is ready (default = database loadout time) (_optional_)
  • IgnoreMagazines = True/False If the new loadout should rely on the magazines having the right weapons ready (default = false) (_optional_)
  • ExcludeOptionalWeapons = True/False Exclude optional weapons from loadout (default = false) (_optional_)
  • Wpn_DBID = number Weapon DB number - required if WPN_GUID is not supplied
  • Wpn_GUID = string Actual weapon to update - DBID is not required as this take precedence (_optional_)
  • Number = number Number to change current weapon load by (sign ignored)
  • Remove = True/False Deduct 'number' rather than add

Returns

booleanTrue

Example