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_AddUnit (table)

This function adds a new unit to a side based on the supplied table.
As the function ScenEdit_SetUnit() is called at the end of this function, any options not listed below will be passed into the next function.
There should be no need to call ScenEdit_SetUnit() seperately.

Parameters

• table {} The unit details to add.
  Note that some settings will depend on the type of unit specified, eg aircraft generally need loadouts and altitude whereas neither is needed by a ship.
  • type = UnitType The description of the type of unit to add ( eg Ship, Sub, ...)
  • unitname = string The name of the unit
  • side = string The side name/GUID to add the unit to
  • dbid = number The database id of the unit
  • base = string Unit base name/GUID where the unit will be 'hosted' (applies to types AIR, SHIP, SUB)
  • latitude = Latitude Not required if a base is defined as unit adopts that location
  • longitude = Longitude Not required if a base is defined as adopts that location
  • altitude = Altitude The Unit altitude (applies to AIR). If a base is defined, it will adopt it's altitude
  • loadoutid = number Aircraft database loadout id (applies to type AIR)
  • orbit = number Orbit index (applies to type SATELLITE)
  • guid = string Optional custom GUID to override the auto generated one

Returns

Unit A wrapper defining the added unit. This will be nil if the function failed to add the unit.

Example