Module `ScenEdit`

Lua is a case sensitve language.

When accessing object properties directly as in 'unit.name', the property should be in lower which will match the Lua generated code. There may be a few special cases (e.g. mission.SISH=true which is a shortcut for scrub_if_side_human) which will be documented below.

However, when accessing the properties through the module functions below, both the keyword/property and the value are case insensitive; the code will worry about matching them up.

Selector
These define the information required as part of the 'select' process for the functions. In the case of functions that 'add' things, these are also key elements to the adding process. Other properties may be included in the 'selector' such as when updating an existing table.

When selecting units, it is preferrable to use the GUID as the identifier for a precise match. If not, then the side and name for a more limited search. And as a last option, just the name which search all units in the scenario. When using just the name, usually the first matching name is returned. This is okay if the names are unique. Thus including the side, it will only check the units on that side for a match.

Wrapper
These define the information that is returned from some functions. This information can be usually modified either directly (object.field) or by a wrapper Set(..) function. The particular wrapper Set(..) function is preferred as some validation is performed on the input to ensure that it is within the bounds of the field being updated.

Data type
These cover any special considerations for the data, such as longitude/latitude; degrees, DMS, N/S, E/W, etc.

Error handling
Usually when a Lua script fails, an error is thrown that ends the script at that point. While this may be okay in most cases, it is not often desired.
Whenever a Command Lua function gets an error, it will normally return a 'nil', and the error message will be available as a Lua global variables; '_errmsg_' will have the last error message, '_errfnc_' the Command Lua function that gave the error, and '_errnum_' the error code (0 is no error, and any value >0 will be an error). Thus if you get back a 'nil', you can check to see if that is due to an error or no data.

Example:
without the new error handling, the script below would probably terminate after the SE_AddMission() and the rest of script would not run.
local mission = ScenEdit_AddMission('USA','Marker strike','strike',{type='land'})
if mission == nil then
if _errnum_ ~= 0 then print('Failed to add:' .. _errmsg_) else print('Something else') end
else
print(mission)
do some more command lua stuff...
end

Note: Due to how errors are now handle from SR7, if a command fails in the console window, it will show an error. If the command runs outside the console (as in an event script), it will not fail with a visible error but return a nil or or some other value. One issue with commands running in an event is that sometimes they fail with an in-game message that actually stops the rest of the script from running. Now, these event scripts will run without any in-game message showing, and the designer should check the result of the command and handle any error condition, and let the remaining script run as needed.

My intent is have all command errors behave in the same fashion in the console window; and the command errors outside a console behave without stopping the script. Which requires the designer to cater for the specific error conditions.

To emulate the expected outcome from an event, put 'Tool_EmulateNoConsole(true)' at the start of the script to be tested; it is not required in the event code as the script is already not running in a console.

Note also, that the Lua history log should also record the event script errors.

Release: 2.11.21

Selector

ActionUpdate	Action update.
ConditionUpdate	Condition update.
ContactSelector	Contact selector.
DamageOptions	Unit damage.
DoctrineSelector	Selects a doctrine.
DoctrineWRASelector	Selects a WRA doctrine.
EventTCAUpdate	Event Trigger/Condition/Action update.
EventUpdate	Event update.
NewMission	New mission options.
NewUnit	New unit selector.
ReferencePointSelector	Reference point selector.
SideOption	Side options.
SpecialAction	Special action selector.
TriggerUpdate	Trigger update.
UnitSelector	Select a unit.
UpdateUnit	Update unit sensor/mount/weapon selector.
UpdateUnitCargo	Update unit cargo selector.
VPContactSelector	Contact selector.
Weapon2Magazine	Select magazine and weapon.
Weapon2Mount	Select mount and weapon.

Wrapper/Descriptor

AttackOptions	Attack options.
Contact	Contact details.
Doctrine	Doctrine options.
DoctrineWRA	WRA Doctrine options.
Event	Event details .
Group	Group details.
Loadout	Loadout.
Mission	Mission.
ReferencePoint	Reference point information.
RefuelOptions	Unit refueling options.
Side	Side perspective.
Unit	Represents a active unit.
Zone	Exclusion/No navigatation zone.

Data types

Altitude	Altitude.
Arc	Arcs.
DateTime	DateTime.
KeyStore	KeyStore.
Latitude	Latitude.
LoadoutRole
LoadoutTimeOfDay
LoadoutWeather
Longitude	Longitude.
Size	Size.
Stance	Stance/Posture.
TargetTypeWRA	Target type.
TimeStamp	TimeStamp.
WeaponDoctrine
WeaponType
Weather	weather conditions.

Notes

WrapperFields

List fields in a wrapper.

Functions

GetBuildNumber ()	Gets the exe build number.
GetScenarioTitle ()	Name of the scenario.
ScenEdit_AddExplosion (explosion)	Detonates a warhead at a specified location.
ScenEdit_AddMinefield (side, dbid, number, delay, area)	attempt to lay a minefield
ScenEdit_AddMission (SideNameOrId, MissionNameOrId, MissionType, MissionOptions)	Add new mission.
ScenEdit_AddReferencePoint (descriptor)	Add new reference point(s).
ScenEdit_AddReloadsToUnit (descriptor)	Adds weapons into a mount.
ScenEdit_AddSide (table)	Add side.
ScenEdit_AddUnit (unit)	Adds a unit based on a descriptor.
ScenEdit_AddWeaponToUnitMagazine (descriptor)	Adds weapons into a magazine.
ScenEdit_AddZone (sideName, zoneType, table)	Add no-nav or exclusion zone.
ScenEdit_AssignUnitAsTarget (AUNameOrIDOrTable, MissionNameOrID)	Assigns targets to a Strike mission.
ScenEdit_AssignUnitToMission (unitname, mission, escort)	Assign a unit to a mission.
ScenEdit_AttackContact (attackerID, contactId, options)	Attack a contact ...
ScenEdit_ClearKeyValue (key, forCampaign)	Clears a key ..
ScenEdit_CurrentLocalTime ()	Get the current scenario local time.
ScenEdit_CurrentTime ()	Get the current scenario time.
ScenEdit_DeleteMine (side, guid)	delete a mine
ScenEdit_DeleteMinefield (side, area)	delete a minefield
ScenEdit_DeleteMission (SideNameOrId, MissionNameOrId)	Delete mission.
ScenEdit_DeleteReferencePoint (selector)	Delete a reference point.
ScenEdit_DeleteUnit (unit, include)	Deletes unit.
ScenEdit_EndScenario ()	Ends the current scenario.
ScenEdit_EventX ()	Active Event ..
ScenEdit_ExecuteEventAction (EventDescriptionOrID)	Execute a Lua Event action script.
ScenEdit_ExecuteSpecialAction (eventNameOrId)	Execute a Lua Special action script ..
ScenEdit_ExportInst (side, unitList, fileData)	Export unit(s) to an inst file.
ScenEdit_ExportMission (SideNameOrId, MissionNameOrId)	Export mission parameters.
ScenEdit_ExportScenarioToXML ()	Export the entire scenario in XML format.
ScenEdit_FillMagsForLoadout (unit, loadoutid, quantity)	Fill a unit's magazine(s) with aircraft stores ...
ScenEdit_GetContact (contact)	Fetches a contact based on a selector.
ScenEdit_GetContacts (side)	Contacts from a side.
ScenEdit_GetDoctrine (selector)	Gets the doctrine of the designated object.
ScenEdit_GetDoctrineWRA (selector)	Gets the WRA doctrine.
ScenEdit_GetEvent (EventDescriptionOrID, level)	Gets the properties of an event.
ScenEdit_GetEvents (level)	Gets all events.
ScenEdit_GetKeyValue (key, forCampaign)	Gets the value for a key from the persistent key store.
ScenEdit_GetLoadout (loadoutinfo)	Gets the loadout details for a unit.
ScenEdit_GetMinefield (side, area)	get a minefield
ScenEdit_GetMission (SideNameOrId, MissionNameOrId)	Get details of a mission.
ScenEdit_GetReferencePoints (selector)	Get a set of reference point(s).
ScenEdit_GetScenHasStarted ()	Has the scenario started?
ScenEdit_GetScore (side)	Get a given side's score.
ScenEdit_GetSideIsHuman (sidename)	Returns true if side is played by a human player
ScenEdit_GetSideOptions (options)	Get side options.
ScenEdit_GetSidePosture (sideA, sideB)	Gets the posture of one side towards another.
ScenEdit_GetSpecialAction (action_info)	Gets the properties of an existing special action.
ScenEdit_GetTimeOfDay (table)	Get the current time of day at a location use an unit selector (guid or side/name) or position selector (latitude,longitude)
ScenEdit_GetUnit (unit)	Fetches a unit based on a selector.
ScenEdit_GetWeather ()	Get the current weather conditions.
ScenEdit_HostUnitToParent (host_info)	Host/base ..
ScenEdit_ImportInst (side, filename)	Imports an inst file.
ScenEdit_ImportMission (SideNameOrId, MissionNameOrId)	Import mission parameters.
ScenEdit_ImportScenarioFromXML ()	Import a scenario from provided XML string
ScenEdit_InputBox (string)	Open an input box with the passed prompt.
ScenEdit_KillUnit (unit)	Kill unit.
ScenEdit_MsgBox (string, style)	Show a message box with a passed string.
ScenEdit_PlaySound (string, delay)	Play a sound file.
ScenEdit_PlayVideo (string, fullscreen, delay)	Play a video file.
ScenEdit_MsgBox (string, style)	Show a message box with a passed string.
ScenEdit_PlayerSide ()	The player's current side.
ScenEdit_QueryDB (type)	Query database
ScenEdit_RefuelUnit (unitOptions)	Cause unit to refuel.
ScenEdit_RemoveSide (table)	Remove side from play.
ScenEdit_RemoveUnitAsTarget (AUNameOrIDOrTable, MissionNameOrID)	Removes targets from a Strike mission.
ScenEdit_RemoveZone (sideName, zoneType, table)	Remove no-nav or exclusion zone.
ScenEdit_RunScript (script)	Runs a script from a file.
ScenEdit_SelectedUnits ()	list of selected unit ids
ScenEdit_SetAction (options)	Sets the attributes of an action.
ScenEdit_SetCondition (options)	Sets the attributes of an condition.
ScenEdit_SetDoctrine (selector, doctrine)	Set the doctrine of the designated object.
ScenEdit_SetDoctrineWRA (selector, options)	Sets the WRA doctrine.
ScenEdit_SetEMCON (type, name, emcon)	Sets the EMCON of the selected object.
ScenEdit_SetEvent (EventDescriptionOrID, options)	Sets the attributes of an event.
ScenEdit_SetEventAction (EventDescriptionOrID, options)	Sets the attributes of a T/C/A.
ScenEdit_SetEventCondition (EventDescriptionOrID, options)	Sets the attributes of a T/C/A.
ScenEdit_SetEventTrigger (EventDescriptionOrID, options)	Sets the attributes of a T/C/A.
ScenEdit_SetKeyValue (key, value, forCampaign)	Sets the value for a key in the persistent key store.
ScenEdit_SetLoadout (loadoutinfo)	Sets the loadout for a unit
ScenEdit_SetMine (side, guid, delay)	update a mine
ScenEdit_SetMission (SideName, MissionNameOrId, MissionOptions)	Set details for a mission.
ScenEdit_SetReferencePoint (descriptor)	Update a reference point(s) with new values.
ScenEdit_SetScore (side, score, reason)	Sets a given side's score.
ScenEdit_SetSideOptions (options)	Set side options.
ScenEdit_SetSidePosture (sideAName, sideBName, posture)	Set the posture of a side towards another.
ScenEdit_SetSpecialAction (action_info)	Sets the properties of an existing special action.
ScenEdit_SetTime (new_time)	Sets the scenario time (UTC).
ScenEdit_SetTrigger (options)	Sets the attributes of a trigger.
ScenEdit_SetUnit (unit)	Sets the properties of a unit that already exists.
ScenEdit_SetUnitDamage (options)	Set unit damage.
ScenEdit_SetUnitSide (sidedesc)	Changes the side of a unit
ScenEdit_SetWeather (temperature, rainfall, undercloud, seastate)	Set the current weather conditions.
ScenEdit_SetZone (sideName, zoneType, table)	update no-nav or exclusion zone.
ScenEdit_SpecialMessage (side, message)	Displays a special message consisting of the HTML text `message` to side `side.
ScenEdit_TransferCargo (fromUnit, toUnit, cargoList)	Transfer cargo ..
ScenEdit_UnitC ()	Detected Contact ...
ScenEdit_UnitX ()	Activating Unit ..
ScenEdit_UnitY ()	Detecting Unit ...
ScenEdit_UnloadCargo (fromUnit, cargoList)	Unload cargo
ScenEdit_UpdateUnit (options)	Update items on a unit.
ScenEdit_UpdateUnitCargo (options)	Update cargo on a unit.
ScenEdit_UseAttachment (attachment)	Import an attachment into the scene.
ScenEdit_UseAttachmentOnSide (attachment, sidename)	Use an attachment on a side (used for .inst files as attachments).
Tool_Bearing ()	Get bearing between points.
Tool_DumpEvents ()	Dump scenario events.
Tool_EmulateNoConsole ()	Emulates no console.
Tool_Range ()	Get range between points.
VP_ExportUnits (table, filename)	Export unit details ...
VP_GetContact (ContactGUID)	Get contact details
VP_GetSide (side)	Side information from player's perspective.
VP_GetUnit (ActiveOrContact)	Get unit details
World_GetCircleFromPoint (table)	Returns a circle around point.
World_GetElevation (location)	Returns the elevation in meters of a given position
World_GetLocation (location)	Returns table of details at a given position
World_GetPointFromBearing (table)	Returns a location based on bearing.

Tables

AAR	AAR.
Cargo	Cargo.
CargoMission	CargoMission.
Component	Component.
EMmatch	EM matches ..
Emissions	Contact emission ..
Explosion	Defines the warhead to detonate.
Facility	Facility.
FerryMission	FerryMission.
Fuel	Fuel.
FuelState	Status of a fuel `type`.
HostUnit	Requests that a unit be hosted/based to another
LatLon	A Position on the map.
LoadoutInfo	Information on a loadout to add/alter
Magazine	Magazine.
MineClearMission	MineClearMission.
MineMission	MineMission.
Mount	Mount.
PatrolMission	PatrolMission.
SideContact	Side's contact.
SideDescription	Information on how to change a unit's side.
SideSelector	Information to select a particular side.
SideUnit	Side's unit.
StrikeMission	StrikeMission.
SupportMission	SupportMission.
WRA	WRA settings.
Waypoint	Waypoint ..
WeaponLoaded	Weapon loads on mount or in magazine.
ZoneMarker	Zone marker.

Selector

ActionUpdate

Action update.

ID string The GUID of the action [READONLY]
Description string Description or GUID of action
NewName string If specified, the new name of the action
Mode string Operation to do - 'list', 'add', 'remove', 'update' (default) SE_Set...()
Type string Type of action [required only for 'add' option]
Other various values apply to Type of action.

ConditionUpdate

Condition update.

ID string The GUID of the condition [READONLY]
Description string Description or GUID of condition
NewName string If specified, the new name of the condition
Mode string Operation to do - 'list', 'add', 'remove', 'update' (default) SE_Set...()
Type string Type of condition [required only for 'add' option]
Other various values apply to Type of condition.

ContactSelector

Contact selector.

Note that a unit and it's contact GUIDs are different for the same physical unit; the contact GUIDs are from the other side's perspective

side string The side to find the the contact on.
guid string The GUID of the contact. Interrogate ScenEdit_GetContacts(side) for the side's contacts and use the GUID from there.

DamageOptions

Unit damage. The component table list consists of entries for each component, identified by guid and new level. Special cases:
- if guid is 'type', then you can set a type of component to be damaged,
- if damageLevel is 'none', then the component will be repaired.

side string
unitname string
guid string
fires string
flood string
dp number Damage points
components { table } Table of component damage setting { guid, damageLevel }

Usage:

components={{'16a883a2-8e7f-4313-aae7-0af644c16337','none'},{'rudder','Medium'},{'type',type='sensor',1}}}')

DoctrineSelector

Selects a doctrine. .. for on a side, group, mission, or unit

side string The side to select/from
mission string The name of the mission to select
unitname string The name of the unit (or group) to select
actual bool =true Show the actual doctrine setting based on doctrine inheritance (defaults to only showing non-inherited values)
escort bool If a strike mission, adding 'escort=true' will update the escort doctrine

DoctrineWRASelector

Selects a WRA doctrine. .. for on a side, group, mission, or unit. weapon_id is mandatory. One of side,mission,unitname or guid is mandatory. One of contact_id or target_type is mandatory If no weapon_id is supplied but just the target_type, then a WRA table (WRA_#) is returned for each weapon for the doctrine that can engage the target_type

side string The side to select/from
mission string The name of the mission to select
unitname string The name of the unit to select
guid string The unit GUID to select
weapon_id string The weapon database id
contact_id string A contact GUID (mutually exclusive with target_type)
target_type string The target type (mutually exclusive with contact_id)

EventTCAUpdate

Event Trigger/Condition/Action update.

GUID string The GUID of the trigger
Description string The description or ID of the T/C/A
Mode string Operation to do - 'add', 'remove', replace', 'update' (default) SE_Set...()

EventUpdate

Event update.

ID string The GUID of the event [READONLY]
Description string If specified, the new description for the event
NewName string If specified, the new name of the event
IsActive bool If the event is active
IsRepeatable bool If the event can occur multiple times
IsShown bool If the event is shown in message log
Probability integer Chance of it happening
Mode string Operation to do - 'add', 'update' (default), 'remove'

NewMission

New mission options.

type string Mission sub-type (Applies to Patrol and Strike)
destination string Ferry mission destination
zone { string } A table of reference points as names or GUIDs (Can apply to Patrol, Support, Mining, Cargo)

NewUnit

New unit selector.

... lists minimum fields required. Other fields from Unit may be included.

type string The type of unit (Ship, Sub, Aircraft, Facility, Satellite)
unitname string The name of the unit
side string The side name or GUID to add unit to
dbid number The database id of the unit
latitude Latitude Not required if a base is defined
longitude Longitude Not required if a base is defined
base string Unit base name or GUID where the unit will be 'hosted' (applicable to AIR, SHIP, SUB)
loadoutid number Aircraft database loadout id (applicable to AIR)
altitude number Unit altitude (applicable to AIR)
depth number Unit depth (applicable to SUBMARINE - note no sign)
orbit number Orbit index (applicable to SATELLITE)
guid string Optional custom GUID to override auto one

ReferencePointSelector

Reference point selector.

To select reference point(s), specify either

name and side, to select a reference point name belonging to side [name AND side if possible] or
guid, if the unique ID of the reference point is known [preferred] or
area, table of reference points (name or guid)

GUID method takes precedence over name/side if both present.

side string The side the reference point is visible to
name string The name of the reference point
guid string The unique identifier for the reference point
area {name or guid} Table of reference points by name and/or guid (used with the Set()/Get() functions)

SideOption

Side options.

side string} Side name
guid string} Side guid
awareness string} Side awareness
proficiency string} Side proficiency
switchto bool} Change game side to above (only applicable with SetSideOptions)

SpecialAction

Special action selector.

GUID string The GUID of the special action [READONLY]
ActionNameOrID string The name or ID of the special action
IsActive bool If the action is visible to the player
IsRepeatable bool If the player can use the action multiple times
NewName string If specified, the new name of the action
Description string If specified, the new description for the action

TriggerUpdate

Trigger update.

ID string The GUID of the trigger [READONLY]
Description string Description or GUID of trigger
NewName string If specified, the new name of the trigger
Mode string Operation to do - 'list', 'add', 'remove', 'update' (default) SE_Set...()
Type string Type of trigger [required only for 'add' option]
Other various values apply to Type of trigger.

UnitSelector

Select a unit. ... based on either the side and name or the unique identifier (GUID).

You can use either 1. name and side 2. guid If both are given, then the GUID is used preferentially.

name string The name of the unit to select (for option #1)
side string The name of the unit to select (for option #1)
guid string The guid of the unit to select (for option #2)

UpdateUnit

Update unit sensor/mount/weapon selector.

... lists minimum fields required. Other fields from Unit may be included. For the 'delta' mode, the function willl look for a matching GUID (or unit name if no GUID match) in the INI file.

guid string The unit identifier
mode string The function to perform (add_ sensor,remove_ sensor,add_ mount,remove_ mount,add_ weapon,remove_ weapon,add_comms,remove_comms,delta)
dbid number The database id of the item to add [required for 'add_' mode]. If used with 'remove_' mode, and no sensorid/mountid, the first matching DBID will be removed.
sensorid string The identifier (guid) of the particular sensor to remove [required for remove_ sensor mode]
mountid string The identifier (guid) of the particular mount to remove [required for remove_ mount mode]
weaponid string The identifier (guid) of the particular weapon to remove [required for remove_ weapon mode]. Must have a preceeding mountid to update
commsid string The identifier (guid) of the particular communication device to remove [required for remove_ mount mode]
file string File name of the INI delta to apply [required for delta mode]
arc_detect { Arcs } The effective arcs for the particular sensor to detect in [override defaults]
arc_track { Arcs } The effective arcs for the particular sensor to track/illuminate in [override defaults]
arc_mount { Arcs } The effective arcs for the particular mount [override defaults]

UpdateUnitCargo

Update unit cargo selector.

... lists minimum fields required. Other fields from Unit may be included.

guid string The unit identifier
mode string The function to perform (add_ cargo,remove_ cargo)
cargoList { Cargo } List of cargo to update: table of {guids}, or { {number, DBID}}

VPContactSelector

Contact selector.

Note that a unit and it's contact GUIDs are different for the same physical unit; the contact GUIDs are from the other side's perspective

guid string The GUID of the contact. Interrogate VP_GetSide().contacts for the side's contacts and use the GUID from there.

Weapon2Magazine

Select magazine and weapon.

A group magazine, for example, tend to have multiple magazines, with the same name. So you can specify a particular magazine by the GUID, or leave it out, and the function will try to fill up any available space with the weapon.

side string The side name/GUID of the unit with magazine
unitname string The name/GUID of unit with magazine
guid string GUID of the unit with magazine
mag_guid string The magazine GUID
wpn_dbid string The weapon database ID
number number Number to add
maxcap number Maximum capacity of the weapon to store
remove bool If true, this will debuct the number of weapons
new bool If true, will add the weapon if it does not exist
fillout bool If true, will fill out the weapon record to its maximum

Weapon2Mount

Select mount and weapon.

You can specify a particular mount by the GUID, or leave it out, and the function will try to fill up any available space with the weapon.

side string The side name/GUID of the unit with mount
unitname string The name/GUID of unit with mount
guid string GUID of the unit with mount
mount_guid string The mount GUID
wpn_dbid string The weapon database ID
number number Number to add
remove bool If true, this will debuct the number of weapons
fillout bool If true, will fill out the weapon record to its maximum

Wrapper/Descriptor

AttackOptions

Attack options.

mode string Targeting mode "AutoTargeted"|"0", "ManualWeaponAlloc"|"1"
mount number The attacker's mount DBID
weapon number The attacker's weapon DBID
qty number How many to allocate

Contact

Contact details.

This is from the perspective of the side being looked at. What is a contact for one side, may not be the same contact on another side. Note also the GUID of the contact is not the same as the actual unit. So depending on what functions you call, you may need to 'convert' the contact 'GUID' into the actual 'GUID' and call GetUnit() to process the actual GUID.

name string The contact name.
guid string The contact GUID. {READONLY]
actualunitid string The contact actual GUID. [READONLY]
latitude Latitude The latitude of the contact. [READONLY]
longitude Longitude The longitude of the contact. [READONLY]
speed number Speed if known [READONLY]
heading number Heading if known [READONLY]
altitude number Altitude if known [READONLY]
missile_defence number Applicable to Facility and Ships. -1 = unknown contact [READONLY]
age number How long has contact been detected (in seconds) [READONLY]
type string Type of contact. [READONLY]
typed number Type of contact. [READONLY]
areaofuncertainty { LatLon } Table of points defining the area of contact. [READONLY]
type_description string Contact type description. [READONLY]
actualunitdbid number Actual contact type. [READONLY]
classificationlevel string Contact classification. [READONLY]
potentialmatches { EMmatch } Table {EMmatch} on potential EMCON emission matches. [READONLY]
side Side Contact's actual side. [READONLY]
fromside Side The side who sees this contact. [READONLY]
detectedBySide Side The side who originally saw this contact. Would be same as fromside unless shared [READONLY]
posture string Posture towards contact.
FilterOut bool True to filtered out contact
weather { Weather } Table of weather parameters (temp, rainfall, underrain, seastate)
BDA { table } Table of battle damage assessment (fires, flood, structural)
emissions { Emissions } Table of detected emmissions from contact
detectionBy { table } Table of how long ago was detected by type (radar, esm, visual, infrared, sonaractive, sonarpassive)
targetedBy { table } Table of unit guids that have this contact as a target
firingAt { table } Table of contact guids that this contact is firing at
firedOn { table } Table of guids that are firing on this contact
DropContact method () Drops contact from the reporting side
inArea method ({area}) Is contact in the 'area' defined by table of RPs (true/false)

Doctrine

Doctrine options.

For each field, adding the suffix "_player_editable" determines if the player can alter the setting. Not applicable to the Withdraw/Deploy options.

When setting the option, the indicated value or it's number can be used.

use_nuclear_weapons bool True if the unit should be able to employ nuclear weapons
engage_non_hostile_targets bool True if the unit should attempt hostile action against units that are not hostile
rtb_when_winchester bool (obsolete, see the new doctrine options) True if the unit should return to base when out of weapons
ignore_plotted_course bool True if the unit should ignore plotted course
engaging_ambiguous_targets string Ignore(0), Optimistic(1), or Pessimistic(2)
automatic_evasion bool True if the unit should automatically evade
maintain_standoff bool True if the unit should try to avoid approaching its target, only valid for ships
use_refuel_unrep string Always_ExceptTankersRefuellingTankers(0), Never(1), Always_IncludingTankersRefuellingTankers(2)
engage_opportunity_targets bool True if the unit should take opportunistic shots
use_sams_in_anti_surface_mode bool True if SAMs should be used to engage surface targets
ignore_emcon_while_under_attack bool True if EMCON should be ignored and all systems should go active when engaged
quick_turnaround_for_aircraft string Yes(0), FightersAndASW(1), No(2)
air_operations_tempo string Surge(0), Sustained(1)
kinematic_range_for_torpedoes string AutomaticAndManualFire(0), ManualFireOnly(1), No(2)
weapon_control_status_air string Free(0), Tight(1), Hold(2)
weapon_control_status_surface string Free(0), Tight(1), Hold(2)
weapon_control_status_subsurface string Free(0), Tight(1), Hold(2)
weapon_control_status_land string Free(0), Tight(1), Hold(2)
refuel_unrep_allied string Yes(0), Yes_ReceiveOnly(1), Yes_DeliverOnly(2), No(3)
fuel_state_planned string Bingo(0), Joker10Percent(1), Joker20Percent(2), Joker25Percent(3), Joker30Percent(4), Joker40Percent(5), Joker50Percent(6), Joker60Percent(7), Joker70Percent(8), Joker75Percent(9), Joker80Percent(10), Joker90Percent(11)
fuel_state_rtb string No(0), YesLastUnit(1), YesFirstUnit(2), YesLeaveGroup(3)
weapon_state_planned WeaponDoctrine See Weapon Doctrine table below
weapon_state_rtb string No(0), YesLastUnit(1), YesFirstUnit(2), YesLeaveGroup(3)
gun_strafing string No(0), Yes(1)
jettison_ordnance string No(0), Yes(1)
avoid_contact string No(0), Yes_ExceptSelfDefence(1), Yes_Always(2)
dive_on_threat string Yes(0), Yes_ESM_Only(1), Yes_Ships20nm_Aircraft30nm(2), No(3)
recharge_on_patrol string Recharge_Empty(0), Recharge_10_Percent(10), Recharge_20_Percent(20), Recharge_30_Percent(30), Recharge_40_Percent(40), Recharge_50_Percent(50), Recharge_60_Percent(60), Recharge_70_Percent(70), Recharge_80_Percent(80), Recharge_90_Percent(90)
recharge_on_attack string Recharge_Empty(0), Recharge_10_Percent(10), Recharge_20_Percent(20), Recharge_30_Percent(30), Recharge_40_Percent(40), Recharge_50_Percent(50), Recharge_60_Percent(60), Recharge_70_Percent(70), Recharge_80_Percent(80), Recharge_90_Percent(90)
use_aip string No(0), Yes_AttackOnly(1), Yes_Always(2)
dipping_sonar string Automatically_HoverAnd150ft(0), ManualAndMissionOnly(1)
bvr_logic string StraightIn(0), Crank(1), Drag(2)
withdraw_on_damage string Ignore(0), Percent5(1), Percent25(2), Percent50(3), Percent75(4)
withdraw_on_fuel string Ignore(0), Bingo(1), Percent25(2), Percent50(3), Percent75(4), Percent100(5)
withdraw_on_attack string Ignore(0), Exhausted(1), Percent25(2), Percent50(3), Percent75(4), Percent100(5), LoadFullWeapons(6)
withdraw_on_defence string Ignore(0), Exhausted(1), Percent25(2), Percent50(3), Percent75(4), Percent100(5), LoadFullWeapons(6)
deploy_on_damage string Ignore(0), Percent5(1), Percent25(2), Percent50(3), Percent75(4)
deploy_on_fuel string Ignore(0) Bingo(1), Percent25(2), Percent50(3), Percent75(4), Percent100(5)
deploy_on_attack string Ignore(0), Exhausted(1), Percent25(2), Percent50(3), Percent75(4), Percent100(5), LoadFullWeapons(6)
deploy_on_defence string Ignore(0), Exhausted(1), Percent25(2), Percent50(3), Percent75(4), Percent100(5), LoadFullWeapons(6)

DoctrineWRA

WRA Doctrine options.

weapon_dbid string Weapon number [info]
weapon_name string Weapon name [info]
target_type TargetTypeWRA Type of target [info]
level string The doctrine selected (at unit/mission/side) - useful Is just using GUIDs [info]
wra { WRA } The WRA doctrine for a single weapon, or wra_# for each weapon against a specific target_type

Event

Event details .

name string The event name.
guid string The event GUID. [READONLY]
description string The event GUID.
details { table} The details of the event with tables for triggers/conditions/actions. [READONLY]
isActive bool The event is active
isRepeatable bool The event repeats
isShown bool The event shows in log
probability string The event chance to occur (0-100)
actions { table} The details of the actions in event [READONLY]
conditions { table} The details of the conditions in event [READONLY]
triggers { table} The details of the triggers in event [READONLY]

Usage:

-- first trigger; as a 'Unit Detected'; what was the target filter values
local Event = ScenEdit_EventX() -- current active event
print(event.details.triggers[1].UnitDetected.TargetFilter)

Group

Group details.

type string Type of group. [READONLY]
guid string [READONLY]
name string
side string [READONLY]
lead string Group leader guid
unitlist { string } Table of unit GUIDs in the group. [READONLY]

Loadout

Loadout.

dbid string ID from database
name string Name of loadout
roles table Table of loadout usage {LoadoutRole, LoadoutTimeOfDay, LoadoutWeather}
weapons { WeaponLoaded } Table of weapons in loadout

Mission

Mission.

guid string The GUID of the mission. [READONLY]
name string Name of mission
isactive bool True if mission is currently active
side string Mission belongs to side
starttime DateTime Time mission starts
endtime DateTime Time mission ends
type MissionClass Mission class(patrol,strike,etc). [READONLY]
subtype MissionSubClass Mission class(asw,land,etc). [READONLY]
SISH bool 'Scrub if side human' tick box
unitlist { GUID } A table of units assigned to mission. [READONLY]
targetlist { GUID } A table of targets assigned to mission. [READONLY]
aar AAR A table of the mission air-to-air refueling options. [READONLY]
ferrymission FerryMission A table of the mission specific options. [READONLY]
mineclearmission MineClearMission A table of the mission specific options. [READONLY]
minemission MineMission A table of the mission specific options. [READONLY]
supportmission SupportMission A table of the mission specific options. [READONLY]
patrolmission PatrolMission A table of the mission specific options. [READONLY]
strikemission StrikeMission A table of the mission specific options. [READONLY]
cargomission CargoMission A table of the mission specific options. [READONLY]

ReferencePoint

Reference point information.

guid string The unique identifier for the reference point
side string The side the reference point is visible to
name string The name of the reference point
latitude Latitude The latitude of the reference point
longitude Longitude The longitude of the reference point
highlighted bool True if the point should be selected
locked bool True if the point is locked
bearingtype bearing Type of bearing Fixed (0) or Rotating (1)
relativeto Unit The unit that reference point is realtive to

RefuelOptions

Unit refueling options.

unitSelector UnitSelector A normal unit selector defining the unit.
tanker string A specific tanker defined by its name (side is assumed to be the same as unit) or GUID.
missions { mission } A table of mission names or mission GUIDs.

Usage:

{side="United States", name="USS Test", missions={"Pitstop"}, tanker="Hose #1"}

Side

Side perspective.

guid string The GUID of the side.
name string The name of the side.
units { SideUnit } Table of units for the designated side. [READONLY]
contacts { SideContact } Table of current contacts for the designated side. [READONLY]
exclusionzones { Zone } Zones for the designated side [READONLY]
nonavzones { Zone } Zones for the designated side [READONLY]
rps { Zone } RPs for the designated side [READONLY]
awareness Awareness [READONLY]
proficiency Proficiency [READONLY]
hasmines booleany [READONLY]
getexclusionzone method (ZoneGUID|ZoneName|ZoneDescription) Returns matching Zone or nil
getnonavzone method (ZoneGUID|ZoneName|ZoneDescription) Returns matching Zone or nil
unitsBy method (UnitType) Returns table of units filtered by type of unit for the designated side or nil.
contactsBy method (UnitType) Returns table of current contacts filtered by type of unit for the designated side or nil.

Unit

Represents a active unit.

type string The type of object, may be 'Facility', 'Ship', 'Submarine', or 'Aircraft'.[READONLY]
name string The unit's name.
side string The unit's side. [READONLY]
guid string The unit's unique ID. [READONLY]
subtype string The unit's subtype (if applicable). [READONLY]
base Unit The unit's assigned base.
latitude Latitude The latitude of the unit.
longitude Longitude The longitude of the unit .
DBID number The database ID of the unit [READONLY]
altitude number The altitude of the unit in meters.
speed number The unit's current speed.
throttle Throttle The unit's current throttle setting.
autodetectable bool True if the unit is automatically detected.
holdposition bool True if the unit should hold.
holdfire { table} Doctrine WCS setting for {air,surface,subsurface,land}. [READONLY]
heading number The unit's heading .
proficiency string The unit proficiency, "Novice"|0, "Cadet"|1,"Regular"|2, "Veteran"|3, "Ace"|4.
newname string If changing existing unit, the unit's new name .
course { WayPoint } The unit's course, as a table of waypoints
fuel { Fuel } A table of fuel types used by unit.
fuels { Fuel } A table of fuel types in tanks used by unit.
mission Mission The unit's assigned mission. Can be changed by setting to the Mission name or guid (calls ScenEdit_AssignUnitToMission)
group Group The unit's group (if applicable). Can be changed assigning an existing or new name. It will try to create a group if new (experimental)
airbornetime number how long aircraft has been flying. [READONLY]
loadoutdbid number current aircraft loadout DBID. [READONLY]
readytime number how long aircraft/ship takes to be ready. [READONLY]
unitstate string Message on unit status. [READONLY]
fuelstate string Message on unit fuel status. [READONLY]
weaponstate string Message on unit weapon status. [READONLY]
condition_v string Docking/Air Ops condition value. [READONLY]
condition string Message on unit dock/air ops status. [READONLY]
classname string Unit class name [READONLY]
manualSpeed string or number Desired speed or 'OFF' to turn off manual mode
manualAltitude string or number Desired altitude/depth or 'OFF' to turn off manual mode
damage { table } Table {dp,flood,fires,startDp} of start and current DP, flood and fire level. [READONLY]
magazines { Magazine } A table of magazines (with weapon loads) in the unit or group. Can be updated by ScenEdit_AddWeaponToUnitMagazine [READONLY]
mounts { Mount } A table of mounts (with weapon loads) in the unit or group. Can be updated by ScenEdit_AddReloadsToUnit [READONLY]
components { Component } A table of components on the unit. [READONLY]
ascontact { table } A table {side,guid,name} of this unit seen from the other sides (as contacts). [READONLY]
weather { Weather } Table of weather parameters (temp, rainfall, underrain, seastate)
areaTriggersFired { table } Table of active 'in area' triggers that have fired for unit
OODA { table } Table contain unit's "observe, orient, decide, act" values {evasion, targeting, detection}
embarkedUnits { table } Table of boats and aircraft docked/embarked on the unit
assignedUnits { table } Table of boats and aircraft assigned to the unit (base)
weapon { table } Table of shooter unit, at contact unit and detonated (when destroyed) if a weapon [READONLY]
targetedBy { table } Table of unit guids that have this unit as a target
firingAt { table } Table of contact guids that this unit is firing at
firedOn { table } Table of guids that are firing on this unit
formation { table } Table of unit's formation info {bearing, type (of bearing), distance, sprint (and drift) }
sprintDrift bool Sprint and drift 'True/False'
inArea method ({area}) Is unit in the 'area' defined by table of RPs (true/false)
delete method () Immediately removes unit object
filterOnComponent method (type) Filters unit on type of component and returns a Component table.
rangetotarget method ('contactid') Calculate flat distance to a contact location
hostFacility { Facility } Where unit is hosted
cargo { Cargo } Unit cargo information
RTB bool Trigger the unit to return to base
Launch method (true/fale) Trigger the unit to launch from base (true) or abort launch (false)
outOfComms bool is unit connected to side comms network (false = connected) [READONLY]
AI_EvaluateTargets_enabled bool AI evaluates targets
AI_DeterminePrimaryTarget_enabled bool AI determines primary target

ScenEdit only
refuel bool Trigger the unit to attempt an UNREP
RTB bool Trigger the unit to return to base
moveto bool Set a desired alt/depth instead of jumping to actual
manualSpeed string or number Desired speed or 'OFF' to turn off manual mode
manualThrottle string or number Desired throttle or 'OFF' to turn off manual mode
manualAltitude string or number Desired altitude/depth or 'OFF' to turn off manual mode

Zone

Exclusion/No navigatation zone.

guid string The GUID of the zone. [READONLY]
description string The description of the zone.
isactive bool Zone is currently active.
area { ZoneMarker } A set of reference points marking the zone. Can be updated by a list of RPs, or a table of new RP values.
affects { unitTypes } List of unit types (ship, submarine, aircraft, facility)
locked bool Zone is locked.
markas Posture Posture of violator of exclusion zone.

Usage:

local a = VP_GetSide({Side ='side1'}) -- a side object
 local z = a.nonavzones - -List Of no-nav zones For the side If you need To find it
 For i, zone in ipairs(z) do
     print("Zone #" .. i)
     print(zone)
     local n = a :  getnonavzone(z[i].guid) -- zone object
     print('Details: ' .. n.description .. ' Active: ' .. tostring(n.isactive) )
 n.area = {'rp-9','rp-10', 'rp-8' } -- replace with a list of visible RPs for the side
 n.area = {
 { name='area test rp0',  latitude='35.5480335331354', longitude='15.8184476823186', highlighted=true, bearingtype=1, relativeto='Tracking #1', hidden = false },
 { name='area test rp1',  latitude='35.5480335331354', longitude='16.8184476823186', highlighted=true, },
 { name='area test rp2',  latitude='38.5480335331354', longitude='18.8184476823186', highlighted=false, } }  -- replace with a new set of RPs that might not be visible to the side
 End

Data types

Altitude

Altitude. ... is the height or depth of a unit. The altitude is displayed in meters when accessing the data. It can be set using either meters or feet by adding M or FT after it. The default is M if just a number is used.

Usage:

{altitude='100 FT'} or {altitude='100 M'} or {altitude='100'}

Arc

Arcs. ... for sensor and mounts.

Arc codes:

Arc codes

DateTime

DateTime. ... is displayed and changed as per LOCALE e.g. US would be 'MM/DD/YYYY HH:MM:SS AM/PM' eg '8/13/2002 12:14 PM'

KeyStore

KeyStore. The simulation allows for user data to be stored within the save file. This is done by associating keys with values. Key/value pairs added to the persistent store is retained when the game is saved and resumed. Keys and values are both represented as non-nil strings.

key string The key to associate the value with
value string The value to keep

Latitude

Latitude. ... is degrees N or S of the equator as 'S 60.20.10' or as +/- as -60.336. The data in the tables is held as a signed number.

LoadoutRole

None = 1001 Intercept_BVR = 2001 Intercept_WVR = 2002 AirSuperiority_BVR = 2003 AirSuperiority_WVR = 2004 PointDefence_BVR = 2005 PointDefence_WVR = 2006 GunsOnly = 2007 AntiSatellite_Intercept = 2101 AirborneLaser = 2102 LandNaval_Strike = 3001 LandNaval_Standoff = 3002 LandNaval_SEAD_ARM = 3003 LandNaval_SEAD_TALD = 3004 LandNaval_DEAD = 3005 LandOnly_Strike = 3101 LandOnly_Standoff = 3102 LandOnly_SEAD_ARM = 3103 LandOnly_SEAD_TALD = 3104 LandOnly_DEAD = 3105 NavalOnly_Strike = 3201 NavalOnly_Standoff = 3202 NavalOnly_SEAD_ARM = 3203 NavalOnly_SEAD_TALD = 3204 NavalOnly_DEAD = 3205 BAI_CAS = 3401 Buddy_Illumination = 3501 OECM = 4001 AEW = 4002 CommandPost = 4003 ChaffLaying = 4004 SearchAndRescue = 4101 CombatSearchAndRescue = 4102 MineSweeping = 4201 MineRecon = 4202 NavalMineLaying = 4301 ASW_Patrol = 6001 ASW_Attack = 6002 Forward_Observer = 7001 Area_Surveillance = 7002 Armed_Recon = 7003 Unarmed_Recon = 7004 Maritime_Surveillance = 7005 Paratroopers = 7101 Troop_Transport = 7102 Cargo = 7201 AirRefueling = 8001 Training = 8101 TargetTow = 8102 TargetDrone = 8103 Ferry = 9001 Unavailable = 9002 Reserve = 9003 ArmedFerry = 9004

LoadoutTimeOfDay

None = 1001 DayNight = 2001 NightOnly = 2002 DayOnly = 2003

LoadoutWeather

None = 1001 AllWeather = 2001 LimitedAllWeather = 2002 ClearWeather = 2003

Longitude

Longitude. ... is degrees E or W of Greenwich line as 'W 60.20.10' or as +/- as -60.336. The data in the tables is held as a signed number.

Size

Size. ... various size attributes (eg flightsize in mission).

When setting the value, either the number or the description (in quotes) can be used.

Flight size:

0	None*
1	SingleAircraft
2	TwoAircraft
3	ThreeAircraft
4	FourAircraft
6	SixAircraft

Flight quantity:

0	None
1	Flight_x1
2	Flight_x2
3	Flight_x3
4	Flight_x4
6	Flight_x6
8	Flight_x8
12	Flight_x12
All	All

Group size:

0	None*
1	SingleVessel
2	TwoVessel
3	ThreeVessel
4	FourVessel
6	SixVessel

*This can also be set by using a value of 'all'.

Stance

Stance/Posture. ... how one side sees another.

When setting the value, either the number or the description (in quotes) can be used. Stance codes:

0	Neutral
1	Friendly
2	Unfriendly
3	Hostile
4	Unknown

TargetTypeWRA

Target type.

None	1001
Decoy	1002
Air_Contact_Unknown_Type	1999
Aircraft_Unspecified	2000
Aircraft_5th_Generation	2001
Aircraft_4th_Generation	2002
Aircraft_3rd_Generation	2003
Aircraft_Less_Capable	2004
Aircraft_High_Perf_Bombers	2011
Aircraft_Medium_Perf_Bombers	2012
Aircraft_Low_Perf_Bombers	2013
Aircraft_High_Perf_Recon_EW	2021
Aircraft_Medium_Perf_Recon_EW	2022
Aircraft_Low_Perf_Recon_EW	2023
Aircraft_AEW	2031
Helicopter_Unspecified	2100
Guided_Weapon_Unspecified	2200
Guided_Weapon_Supersonic_Sea_Skimming	2201
Guided_Weapon_Subsonic_Sea_Skimming	2202
Guided_Weapon_Supersonic	2203
Guided_Weapon_Subsonic	2204
Guided_Weapon_Ballistic	2211
Satellite_Unspecified	2300
Surface_Contact_Unknown_Type	2999
Ship_Unspecified	3000
Ship_Carrier_0_25000_tons	3001
Ship_Carrier_25001_45000_tons	3002
Ship_Carrier_45001_95000_tons	3003
Ship_Carrier_95000_tons	3004
Ship_Surface_Combatant_0_500_tons	3101
Ship_Surface_Combatant_501_1500_tons	3102
Ship_Surface_Combatant_1501_5000_tons	3103
Ship_Surface_Combatant_5001_10000_tons	3104
Ship_Surface_Combatant_10001_25000_tons	3105
Ship_Surface_Combatant_25001_45000_tons	3106
Ship_Surface_Combatant_45001_95000_tons	3107
Ship_Surface_Combatant_95000_tons	3108
Ship_Amphibious_0_500_tons	3201
Ship_Amphibious_501_1500_tons	3202
Ship_Amphibious_1501_5000_tons	3203
Ship_Amphibious_5001_10000_tons	3204
Ship_Amphibious_10001_25000_tons	3205
Ship_Amphibious_25001_45000_tons	3206
Ship_Amphibious_45001_95000_tons	3207
Ship_Amphibious_95000_tons	3208
Ship_Auxiliary_0_500_tons	3301
Ship_Auxiliary_501_1500_tons	3302
Ship_Auxiliary_1501_5000_tons	3303
Ship_Auxiliary_5001_10000_tons	3304
Ship_Auxiliary_10001_25000_tons	3305
Ship_Auxiliary_25001_45000_tons	3306
Ship_Auxiliary_45001_95000_tons	3307
Ship_Auxiliary_95000_tons	3308
Ship_Merchant_Civilian_0_500_tons	3401
Ship_Merchant_Civilian_501_1500_tons	3402
Ship_Merchant_Civilian_1501_5000_tons	3403
Ship_Merchant_Civilian_5001_10000_tons	3404
Ship_Merchant_Civilian_10001_25000_tons	3405
Ship_Merchant_Civilian_25001_45000_tons	3406
Ship_Merchant_Civilian_45001_95000_tons	3407
Ship_Merchant_Civilian_95000_tons	3408
Submarine_Surfaced	3501
Subsurface_Contact_Unknown_Type	3999
Submarine_Unspecified	4000
Land_Contact_Unknown_Type	4999
Land_Structure_Soft_Unspecified	5000
Land_Structure_Soft_Building_Surface	5001
Land_Structure_Soft_Building_Reveted	5002
Land_Structure_Soft_Structure_Open	5005
Land_Structure_Soft_Structure_Reveted	5006
Land_Structure_Soft_Aerostat_Moring	5011
Land_Structure_Hardened_Unspecified	5100
Land_Structure_Hardened_Building_Surface	5101
Land_Structure_Hardened_Building_Reveted	5102
Land_Structure_Hardened_Building_Bunker	5103
Land_Structure_Hardened_Building_Underground	5104
Land_Structure_Hardened_Structure_Open	5105
Land_Structure_Hardened_Structure_Reveted	5106
Runway_Facility_Unspecified	5200
Runway	5201
Runway_Grade_Taxiway	5202
Runway_Access_Point	5203
Radar_Unspecified	5300
Mobile_Target_Soft_Unspecified	5400
Mobile_Target_Soft_Mobile_Vehicle	5401
Mobile_Target_Soft_Mobile_Personnel	5402
Mobile_Target_Hardened_Unspecified	5500
Mobile_Target_Hardened_Mobile_Vehicle	5501
Underwater_Structure	5601
Air_Base_Single_Unit_Airfield	5801

TimeStamp

TimeStamp. ... is a representation of time defined as the number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970

WeaponDoctrine

Value	Number	Explanation
LoadoutSetting	0	use setting from database
Winchester	2001	Vanilla Winchester.
Winchester_ToO	2002	Same as above, but engage nearby bogies with guns after we're out of missiles. Applies to air-to-air missile loadouts only. For guns-only air-to-air loadouts and all air-to-ground loadouts the behaviour is the same as above. PREFERRED OPTION!
ShotgunBVR	3001	Disengage after firing all Beyond Visual Range (BVR, air-to-air) or Stand-Off (SO, air-to-ground) weapons. This is a risky option as your fighter aircraft may only have one medium-range air-to-air missile (AAM) left, and attempt to engage 'fresh' flights of bogies. Use with caution.
ShotgunBVR_WVR	3002	Same as above, but if easy targets or threats are nearby then shoot at them with remaining Within Visual Range (WVR, air-to-air) or SR (Short-Range, air-to-ground) weapons before disengaging.
ShotgunBVR_WVR_Guns	3003	Same as above, but also engage bogies with guns. Applies to air-to-air (A/A) loadouts only. For air-to-ground (A/G) loadouts the behaviour is the same as above.
ShotgunOneEngagementBVR	5001	Make one engagement with BVR or SO weapons. Continue fighting for as long as there are targets within easy reach and then disengage. This is a safe option as it ensures aircraft do not 'hang around' after they have expended their most potent weapons, and becoming easy targets when engaged by 'fresh' enemy units.
ShotgunOneEngagementBVR_Opportunity_WVR	5002	Same as above, but if easy targets or threats are nearby, shoot at them with remaining WVR or Short-Range weapons before disengaging. A target is considered 'easy' when within 120% of the remaining WVR or Strike weapon's maximum range. In other words, the fighter won't spend much energy chasing down a target after the Shotgun weapon state has been reached, and will leave the target area as quickly as possible. PREFERRED OPTION!
ShotgunOneEngagementBVR_Opportunity_WVR_Guns	5003	Same as above, but also engage bogies with guns. Applies to air-to-air (A/A) loadouts only. For air-to-ground (A/G) loadouts the behaviour is the same as above.
ShotgunOneEngagementBVR_And_WVR	5005	Make one engagement with BVR and WVR, or SO and Strike Weapons. Do not disengage when out of BVR or SO weapons, but continue the engagement with WVR weapons.
ShotgunOneEngagementBVR_And_WVR_Opportunity_Guns	5006
ShotgunOneEngagementWVR	5011	Make one engagement with WVR or SR weapons. Continue fighting for as long as there are targets within easy reach and then disengage.
ShotgunOneEngagementWVR_Guns	5012	Same as above but also engage bogies with guns. Applies to air-to-air (A/A) loadouts only. For air-to-ground (A/G) loadouts, the behaviour is the same as above. PREFERRED OPTION!
ShotgunOneEngagementGun	5021	Make one engagement with guns. Continue fighting for as long as there are targets nearby and then disengage.
Shotgun25	4001	Disengage after 1/4 of mission-specific weapons have been expended.
Shotgun25_ToO	4002	Same as above, but if easy targets or threats are nearby then shoot at those too. Also engage bogies with guns. Applies to air-to-air (A/A) loadouts only.
Shotgun50	4011	Disengage after half of mission-specific weapons have been expended.
Shotgun50_ToO	4012	Same as above, but if easy targets or threats are nearby then shoot at those too. Also engage bogies with guns. Applies to air-to-air (A/A) loadouts only.
Shotgun75	4021	Disengage after 3/4 of mission-specific weapons have been expended.
Shotgun75_ToO	4022	Same as above, but if easy targets or threats are nearby then shoot at those too. Also engage bogies with guns. Applies to air-to-air (A/A) loadouts only.

WeaponType

    None = 1001
    GuidedWeapon = 2001
    Rocket = 2002
    IronBomb = 2003
    Gun = 2004
    Decoy_Expendable = 2005
    Decoy_Towed = 2006
    Decoy_Vehicle = 2007
    TrainingRound = 2008
    Dispenser = 2009
    ContactBomb_Suicide = 2010
    ContactBomb_Sabotage = 2011
    GuidedProjectile = 2012
    SensorPod = 3001
    DropTank = 3002
    BuddyStore = 3003
    FerryTank = 3004
    Torpedo = 4001
    DepthCharge = 4002
    Sonobuoy = 4003
    BottomMine = 4004
    MooredMine = 4005
    FloatingMine = 4006
    MovingMine = 4007
    RisingMine = 4008
    DriftingMine = 4009
    DummyMine = 4011
    HeliTowedPackage = 4101
    RV = 5001
    Laser = 6001
    HGV = 8001
    Cargo = 9001
    Troops = 9002
    Paratroops = 9003

Weather

weather conditions.

temp number Temperature (average for GetWeather(), or time-of-day for unit/contact)
rainfall number Rainfall rate
undercloud number Fraction under cloud
seastate number Sea state

Notes

WrapperFields

List fields in a wrapper.

To get a list of fields in a Command Lua wrapper
1. Get an object wrapper (eg unit = ScenEdit_GetUnit())
2. List the properties ( eg print(unit.fields) )
3. Properties consists of (a) name, (b) type of property, and (c) if you set a value for it (eg unit fields = { property_29 = '.damage , LuaTable , False', property_19 = '.dbid , Int32 , False', method_1 = ':delete , System.Void', property_28 = '.loadoutdbid , Object , False', method_2 = ':inArea , System.Boolean, property_9 = '.course , LuaTable , True' ...
-> property_29 : unit.damage is a Lua table and you can't set a value as in unit.damage = {}
-> property_19 : unit.dbid is a number and you can't set a value as in unit.dbid = 12
-> property_28 : unit.loadoutdbid is a generic object and you can't set a value as in unit.loadoutdbid = 1234
-> property_9 : unit.course is a Lua table and you can set a value as in unit.course = {...}
-> method_1 : unit:delete is a Lua method/function and returns nothing
-> method_2 : unit:inArea is a Lua method/function and returns true/false

Functions

GetBuildNumber ()

Gets the exe build number.

Returns:

string

GetScenarioTitle ()

Name of the scenario.

Returns:

string

ScenEdit_AddExplosion (explosion)

Detonates a warhead at a specified location.

Parameters:

explosion Explosion Describes the explosion.

Usage:

ScenEdit_AddExplosion ({warheadid=253, lat=unit.latitude, lon=unit.longitude, altitude=unit.altitude})

ScenEdit_AddMinefield (side, dbid, number, delay, area)

attempt to lay a minefield

Parameters:

side string} Side name or guid
dbid integer The database id of the mine to use
number integer The number to try to lay
delay integer The arming delay in seconds
area table The area (as table of RP points) to lay mines in

Returns:

integer

Usage:

local a = ScenEdit_AddMinefield({side='Blue', dbid=2345, number=100, delay=60000, area={'rp-1','rp-2', 'rp-3', 'rp-4'} } )

ScenEdit_AddMission (SideNameOrId, MissionNameOrId, MissionType, MissionOptions)

Add new mission.

Parameters:

SideNameOrId string The mission side
MissionNameOrId string The mission name
MissionType string The mission type (Strike, Ferry, Patrol, etc)
MissionOptions NewMission The mission specific options as a table

Returns:

Mission

Usage:

local mission = ScenEdit_AddMission('USA','Marker strike','strike',{type='land'})

ScenEdit_AddReferencePoint (descriptor)

Add new reference point(s).

This function adds new reference point(s) as defined by a descriptor. As this function also calls ScenEdit_SetReferencePoint() at the end, those parameters can also be passed in this function.
It can take a new referrnce point, or a table of new reference points. The descriptor must contain at least a side, and one set of latitude and longitude, or an area defined by one or more latitude and longitude values. Points can also be relative to a unit based on bearing and distence. This applies to ALL bearing type rp(s) in the function. Field = RelativeTo The unit name/GUID that the RP(s) are relative to

Parameters:

descriptor ReferencePointSelector or {ReferencePoint} The reference point details to be created. Field 'area' can be
(a) Table of reference points {name, longitude, latitude} if 'RelativeTo' not used, or
(b) table of reference points {name, bearing, distance} if 'RelativeTo' used.
Leaving out name will default it to noraml 'RP-..'

Returns:

ReferencePoint

Usage:

ScenEdit_AddReferencePoint( {side="United States", name="Downed Pilot", lat=0.1, lon=4, highlighted=true})

ScenEdit_AddReferencePoint( {side='sidea', RelativeTo='USN Dewey', bearing=45 ,distance=20, clear=true })

ScenEdit_AddReloadsToUnit (descriptor)

Adds weapons into a mount.

Parameters:

descriptor Weapon2Mount Describes the weapon and mount to update

Returns:

number

Usage:

ScenEdit_AddReloadsToUnit({unitname='Mech Inf #1', w_dbid=773, number=1, w_max=10})

ScenEdit_AddSide (table)

Add side.
...

Parameters:

table { table } The side

Returns:

Side

ScenEdit_AddUnit (unit)

Adds a unit based on a descriptor.

Parameters:

unit NewUnit The unit details to add

Returns:

Unit

Usage:

ScenEdit_AddUnit({type = 'Aircraft', name = 'F-15C Eagle', loadoutid = 16934,
heading = 0, dbid = 3500, side = 'NATO', Latitude="N46.00.00",Longitude="E25.00.00",
altitude="5000 ft",autodetectable="false",holdfire="true",proficiency=4})

ScenEdit_AddUnit({type = 'Air', unitname = 'F-15C Eagle', loadoutid = 16934, dbid = 3500, side = 'NATO', Lat="5.123",Lon="-12.51",alt=5000})

ScenEdit_AddWeaponToUnitMagazine (descriptor)

Adds weapons into a magazine.

Parameters:

descriptor Weapon2Magazine Describes the weapon and magazine to update

Returns:

number

Usage:

ScenEdit_AddWeaponToUnitMagazine({unitname='Ammo', w_dbid=773, number=1, w_max=10})

ScenEdit_AddZone (sideName, zoneType, table)

Add no-nav or exclusion zone.
... The RPs are normally visible to the side. They can start out 'hidden' by adding hidden=1 to the table

Parameters:

sideName string Side name/GUID
zoneType string Type of zone to add: 0 = no-nav, 1 = exclusion
table { table } Description, Isactive, Area { of RPs }, Affects { of UnitTypes }, MarkAs (exc only), Locked (non only)

Returns:

{ Zone }

ScenEdit_AssignUnitAsTarget (AUNameOrIDOrTable, MissionNameOrID)

Assigns targets to a Strike mission.

'UnitX' can be used as a unit descriptor. Contacts can also be assigned. Refer to the VP_ functions for details

Parameters:

AUNameOrIDOrTable string or table The name/GUID of the unit, or a table of name/GUID to add to target list
MissionNameOrID string The mission to update

Returns:

{ GUID }

Usage:

ScenEdit_AssignUnitAsTarget({'target1', 'target2'}, 'Land strike')

ScenEdit_AssignUnitAsTarget('UnitX', 'Land strike')

ScenEdit_AssignUnitToMission (unitname, mission, escort)

Assign a unit to a mission.

The function takes a unit and mission descriptor, and assigns the unit to the mission if it exists. Produces a pop up error (not catchable) if the unit or mission does not exist. The 'UnitX' can be used as the unit descriptor

Parameters:

unitname string The name/GUID of the unit to assign
mission string The mission name/GUID to use
escort bool [Default=False] If the mission is a strike one, then assign unit to the 'Escort' for the strike

Returns:

boolean

Usage:

ScenEdit_AssignUnitToMission("Bar #1", "Strike")

ScenEdit_AttackContact (attackerID, contactId, options)

Attack a contact ... as an auto-target or manual target with weapon allocation

Parameters:

attackerID string The unit attacking as GUID or Name
contactId string The contact being attacked as GUID or Name (GUID is better as the name can change as its classification changes)
options { AttackOptions } Contains type of attack and weapon allocation if required)

Returns:

bool

Usage:

ScenEdit_AttackContact(attackerID, contactId ,{mode='1', mount=438, weapon=1413, qty=10}) -- alloc 10 gunfire

ScenEdit_ClearKeyValue (key, forCampaign)

Clears a key

.. or all keys from the persistent key store.

Parameters:

key string The key to clear or empty for all
forCampaign bool Use key store for passing ed to next scenario in campaign. Optional, default = false

Returns:

bool

Usage:

ScenEdit_ClearKeyValue("A")

ScenEdit_CurrentLocalTime ()

Get the current scenario local time.

Returns:

String

ScenEdit_CurrentTime ()

Get the current scenario time.

Returns:

TimeStamp

Usage:

local now = ScenEdit_CurrentTime()
local elapsed = now - timeFromLastTiggered
if elapsed > 60*5 then
-- been more than 5 minutes, set the lastTriggered time to now
 timeFromLastTiggered = now
end

ScenEdit_DeleteMine (side, guid)

delete a mine

Parameters:

side string} Side name or guid
guid string} Mine guid

Returns:

boolean

Usage:

local a = ScenEdit_DeleteMine({side='Blue', guid='cccccccc'} )

ScenEdit_DeleteMinefield (side, area)

delete a minefield

Parameters:

side string} Side name or guid
area table The area (as table of RP points) to lay mines in

Returns:

number

Usage:

local a = ScenEdit_DeleteMinefield({side='Blue', area={'rp-1','rp-2', 'rp-3', 'rp-4'} } )

ScenEdit_DeleteMission (SideNameOrId, MissionNameOrId)

Delete mission. .. unassigns any units attached to it.

Parameters:

SideNameOrId string The mission side
MissionNameOrId string The mission name

Returns:

bool

Usage:

local mission = ScenEdit_AddMission('USA','Marker strike','strike',{type='land'})

ScenEdit_DeleteReferencePoint (selector)

Delete a reference point.

Given a reference point selector, this function will remove it.

Parameters:

selector ReferencePointSelector The reference point to delete.

Returns:

bool

ScenEdit_DeleteUnit (unit, include)

Deletes unit. .. and no event triggers.

Parameters:

unit
include attached units with group for deleting

Usage:

ScenEdit_DeleteUnit({side="United States", unitname="USS Abcd"})

ScenEdit_EndScenario ()

Ends the current scenario.

Usage:

ScenEdit_EndScenario()

ScenEdit_EventX ()

Active Event .. that has been triggered. Otherwise, a nil is returned.

Note that EventX() can also be used as a shortcut for ScenEdit_EventX()

Returns:

Event

Usage:

local event = ScenEdit_EventX()

ScenEdit_ExecuteEventAction (EventDescriptionOrID)

Execute a Lua Event action script. .. but does not show results of execution of the action

Parameters:

EventDescriptionOrID string The description or ID of the event action

Returns:

string

ScenEdit_ExecuteSpecialAction (eventNameOrId)

Execute a Lua Special action script .. but does not show results of execution of the action

Parameters:

eventNameOrId string The name or ID of the event action

Returns:

string

ScenEdit_ExportInst (side, unitList, fileData)

Export unit(s) to an inst file.

Parameters:

side string The side to import the inst file as
unitList table list of unit(s) to create as INST file
fileData table Table of { filename, name, comment } for the INST file

ScenEdit_ExportMission (SideNameOrId, MissionNameOrId)

Export mission parameters. .. as a XML file in folder Command_base/Defaults. [Experimental as this should really be treated like an attachment so can be imported with Scenario]

Parameters:

SideNameOrId string The mission side
MissionNameOrId string The mission name

Returns:

{ guid }

Usage:

local mission = ScenEdit_ExportMission('USA','Marker strike'})

ScenEdit_ExportScenarioToXML ()

Export the entire scenario in XML format.

Returns:

string

Usage:

theXML = ScenEdit_ExportScenarioToXML()

ScenEdit_FillMagsForLoadout (unit, loadoutid, quantity)

Fill a unit's magazine(s) with aircraft stores ... for a specified loadout ID. (options)

Parameters:

unit UnitSelector The unit to select (name or GUID)
loadoutid number ID of the desired loadout
quantity number How many 'packs' of the specified loadout to populate for

Returns:

List of reports for successful (or not) additions

Usage:

ScenEdit_FillMagsForLoadout('{unit='RAF Lakenheath', loadoutid=45162, quantity=12}')

ScenEdit_GetContact (contact)

Fetches a contact based on a selector.

This function is mostly identical to ScenEdit_GetUnit except that if references contacts on a side,

Parameters:

contact ContactSelector The contact to select. Must be defined by a side and contact GUID for that side.

Returns:

Contact

Usage:

ScenEdit_GetContact({side="United States", guid="c4114322-900c-428d-a3e3-0af701e81a7a"})

ScenEdit_GetContacts (side)

Contacts from a side.

Parameters:

side string The name/guid of the side's contacts.

Returns:

{ Contacts}

Usage:

local con = ScenEdit_GetContacts('south korea')

ScenEdit_GetDoctrine (selector)

Gets the doctrine of the designated object.

This function looks up the doctrine of the object selected by selector, and throws an exception if the unit does not exist.

Parameters:

selector DoctrineSelector The selector for the object to look up

Returns:

Doctrine

Usage:

ScenEdit_GetDoctrine({side="Soviet Union"}).use_nuclear_weapons

ScenEdit_GetDoctrineWRA (selector)

Gets the WRA doctrine.

Returns the WRA setting In a table For the selected side/mission/unit based On the target type. Nothing returned Or empty values means that the weapon Is Not For the target type.

Parameters:

selector DoctrineWRASelector The selector for the object to look up

Returns:

DoctrineWRA

Usage:

ScenEdit_GetDoctrineWRA({guid = 'a1a52edf-3541-4b55-bea4-58d4e1ab11dc', contact_id='Boeing 747-8F #610', weapon_id=1575})

ScenEdit_GetDoctrineWRA({side='sidea', target_type='Surface_Contact_Unknown_Type', weapon_id=1575})

ScenEdit_GetEvent (EventDescriptionOrID, level)

Gets the properties of an event.

Parameters:

EventDescriptionOrID string The event to retrieve
level number The detail required: 0 - full event, (limit return to 1 - triggers, 2 - conditions, 3 - actions, 4 - event)

Returns:

Event

ScenEdit_GetEvents (level)

Gets all events.

Parameters:

level number The detail required: 0 - full event, (limit return to 1 - triggers, 2 - conditions, 3 - actions, 4 - event)

Returns:

{ Event}

ScenEdit_GetKeyValue (key, forCampaign)

Gets the value for a key from the persistent key store.

This function retrieves a value put into the store by ScenEdit_SetKeyValue. The keys must be identical.

Parameters:

key string The key to fetch the associated value of
forCampaign bool Read from the store being passed to next scenario in campaign. Optional, default = false

Returns:

string

Usage:

ScenEdit_SetKeyValue("A","2")
ScenEdit_GetKeyValue("A") -- returns "2"

ScenEdit_GetLoadout (loadoutinfo)

Gets the loadout details for a unit. Use loadoutid =0 or omit to get the a/c current loadout status (ie number of weapons left)

Parameters:

loadoutinfo LoadoutInfo The loadout information to apply

Returns:

Loadout

ScenEdit_GetMinefield (side, area)

get a minefield

Parameters:

side string} Side name or guid
area table The area (as table of RP points) to lay mines in

Returns:

table

Usage:

local a = ScenEdit_GetMinefield({side='Blue', area={'rp-1','rp-2', 'rp-3', 'rp-4'} } )

ScenEdit_GetMission (SideNameOrId, MissionNameOrId)

Get details of a mission.

Parameters:

SideNameOrId string The mission side
MissionNameOrId string The mission name

Returns:

Mission

Usage:

local mission = ScenEdit_GetMission('USA','CV CAP Left')

ScenEdit_GetReferencePoints (selector)

Get a set of reference point(s).

Given a reference point selector, the function will return a table of the reference point descriptors.

Parameters:

selector ReferencePointSelector

Returns:

{ReferencePoint}

Usage:

local points = ScenEdit_GetReferencePoints({side="United States", area={"rp-100","rp-101","rp-102","rp-103","rp-104"})

ScenEdit_GetScenHasStarted ()

Has the scenario started?

Returns:

bool

Usage:

local state = ScenEdit_GetScenHasStarted()

ScenEdit_GetScore (side)

Get a given side's score.

Parameters:

side string The name of the side

Returns:

num

Usage:

ScenEdit_GetScore("PlayerSide")

ScenEdit_GetSideIsHuman (sidename)

Returns true if side is played by a human player

Parameters:

sidename string The name of the side to check if is human controlled

Returns:

True iff the side specified is human

ScenEdit_GetSideOptions (options)

Get side options. ... for components on unit. (options)

Parameters:

options SideSelector

Returns:

{ SideOption }

Usage:

ScenEdit_GetSideOptions({side='SideA'})

ScenEdit_GetSidePosture (sideA, sideB)

Gets the posture of one side towards another.

Parameters:

sideA string The name of the first side
sideB string The name of the second side

Returns:

The posture of sideA towards sideB, one of 'N', 'F', 'H', or 'A'.

ScenEdit_GetSpecialAction (action_info)

Gets the properties of an existing special action.

Parameters:

action_info SpecialAction The special action to retrieve

ScenEdit_GetTimeOfDay (table)

Get the current time of day at a location use an unit selector (guid or side/name) or position selector (latitude,longitude)

Parameters:

table table The unit location or position

Returns:

table

Usage:

ScenEdit_GetTimeOfDay( table)

ScenEdit_GetUnit (unit)

Fetches a unit based on a selector.

This function is mostly identical to ScenEdit_SetUnit except that if no unit is selected by the selector portion of unit, then the function returns nil instead of producing an exception.

Parameters:

unit UnitSelector The unit to select.

Returns:

Unit

Usage:

ScenEdit_GetUnit({side="United States", unitname="USS Test"})

ScenEdit_GetWeather ()

Get the current weather conditions.

Returns:

table

Usage:

ScenEdit_GetWeather()

ScenEdit_HostUnitToParent (host_info)

Host/base .. to the specified host. SelectedHostNameOrID' option: the unit will be moved from any location, including flying, to the new location.

Parameters:

host_info HostUnit The information about the hosting request

ScenEdit_ImportInst (side, filename)

Imports an inst file.

Parameters:

side string The side to import the inst file as
filename string The filename of the inst file

ScenEdit_ImportMission (SideNameOrId, MissionNameOrId)

Import mission parameters. .. from a XML file in folder Command_base/Defaults. [Experimental as this should really be treated like an attachment so can be imported with Scenario]

Parameters:

SideNameOrId string The mission side
MissionNameOrId string The mission name

Returns:

{ guid }

Usage:

local mission = ScenEdit_ExportMission('USA','Marker strike'})

ScenEdit_ImportScenarioFromXML ()

Import a scenario from provided XML string

Returns:

boolean

Usage:

ScenEdit_ImportScenarioFromXML({XML='...'})

ScenEdit_InputBox (string)

Open an input box with the passed prompt.

Parameters:

string string The string to display to the user

Returns:

Data entered into box

ScenEdit_KillUnit (unit)

Kill unit. ... and triggers event. (unit)

Parameters:

unit

Returns:

bool

Usage:

ScenEdit_KillUnit({side='SideA',unitname='ship'})

ScenEdit_MsgBox (string, style)

Show a message box with a passed string.

Style numbers 1 = OK and Cancel buttons. 2 = Abort, Retry, and Ignore buttons. 3 = Yes, No, and Cancel buttons 4 = Yes and No buttons. 5 = Retry and Cancel buttons.

Parameters:

string string The string to display to the user
style num The style of the message box

Returns:

button number pressed.

ScenEdit_PlaySound (string, delay)

Play a sound file.

Parameters:

string string The name of the file. Assumed to be in the Sounds\Effects folder
delay number Delay to playing

Returns:

bool False if it can't find the file

ScenEdit_PlayVideo (string, fullscreen, delay)

Play a video file.

Parameters:

string string The name of the file. Assumed to be in the Video folder
fullscreen boolean Shown in full screen
delay number Delay to showing

Returns:

string "N" if it can't find the file

ScenEdit_PlayerSide ()

The player's current side.

Returns:

string

Usage:

local side = ScenEdit_PlayerSide()

ScenEdit_QueryDB (objectType, DBID)

Query database use the wrapper_object_variable.fields to see what can be returned

Parameters:

objectType string The type of item to query; 'weapon', 'mount', 'sensor'
DBID integer The databse id of item to query

Returns:

object

Usage:

local a = ScenEdit_QueryDB('weapon',1398)

ScenEdit_RefuelUnit (unitOptions)

Cause unit to refuel.

The unit should follow it's AAR configuration. You can force it use a specific tanker or ones from a set of missions.

Parameters:

unitOptions RefuelOptions The unit and refueling options.

Returns:

String

Usage:

ScenEdit_RefuelUnit({side="United States", unitname="USS Test"})

ScenEdit_RefuelUnit({side="United States", unitname="USS Test", tanker="Hose #1"})

ScenEdit_RefuelUnit({side="United States", unitname="USS Test", missions={"Pitstop"}})

ScenEdit_RemoveSide (table)

Remove side from play. This removes ALL units and contacts.

Parameters:

table { table } The side

Returns:

Side

ScenEdit_RemoveUnitAsTarget (AUNameOrIDOrTable, MissionNameOrID)

Removes targets from a Strike mission.

The 'UnitX' can be used as a unit descriptor

Parameters:

AUNameOrIDOrTable string or table The name/GUID of the unit, or a table of name/GUID to remove from target list
MissionNameOrID string The mission

Returns:

{ GUID }

Usage:

ScenEdit_RemoveUnitAsTarget({'target1', 'target2'}, 'Land strike')

ScenEdit_RemoveZone (sideName, zoneType, table)

Remove no-nav or exclusion zone.
... Note that this will drop the zone with any area RPs

Parameters:

sideName string Side name/GUID
zoneType string Type of zone to remove: 0 = no-nav, 1 = exclusion
table { table } Description, Isactive, Area { of RPs }, Affects { of UnitTypes }, MarkAs (exc only), Locked (non only)

Returns:

{ Zone }

ScenEdit_RunScript (script)

Runs a script from a file. The file script must be inside the [Command base directory]/Lua directory, or else the game will not be able to load it. You can make the file point to files within a sub-directory of this, as in 'library/cklib.lua' The file to find will be of the form [Command base directory]/Lua/[script] A file can also be loaded indirectly from an attachment ScenEdit_UseAttachment

Parameters:

script The file containing the script to run.

Usage:

ScenEdit_RunScript('mylibrary.lua')

ScenEdit_SelectedUnits ()

list of selected unit ids

Returns:

table

ScenEdit_SetAction (options)

Sets the attributes of an action.

Parameters:

options { ActionUpdate } The action options

Returns:

{ table }

ScenEdit_SetCondition (options)

Sets the attributes of an condition.

Parameters:

options { ConditionUpdate } The condition options

Returns:

{ table }

ScenEdit_SetDoctrine (selector, doctrine)

Set the doctrine of the designated object.

This function uses selector to find the thing to modify, then modifies the doctrine of that object based on the given object. Can be used to affect doctrine for Side, Mission, Unit/Group

Parameters:

selector DoctrineSelector The selector for the object to modify.
doctrine Doctrine A table of doctrines to update

Usage:

ScenEdit_SetDoctrine({side="Soviet Union"}, {kinematic_range_for_torpedoes = "AutomaticAndManualFire",use_nuclear_weapons= "yes" })

ScenEdit_SetDoctrine({side="Soviet Union", mission="ASW PATROL"}, {kinematic_range_for_torpedoes = "AutomaticAndManualFire",use_nuclear_weapons= "yes" })

ScenEdit_SetDoctrine({side="Soviet Union", unitname="Bear #2"}, {use_nuclear_weapons= "yes" })

ScenEdit_SetDoctrineWRA (selector, options)

Sets the WRA doctrine.

Returns the WRA setting like GetDoctrineWRA

The values below can be used in the option settings 'inherit' = reverts to the side level setting 'system' = reverts to the database level setting (does not apply to 'firing_range') 'max' = use the appropriate maximum setting 'none' = not to be used

Parameters:

selector DoctrineWRASelector The selector for the object to update
options { WRA } Table of settings {qty_salvo, shooter_salvo,firing_range,self_defence}. The order IS IMPORTANT as no keys used.

Returns:

DoctrineWRA

Usage:

ScenEdit_SetDoctrineWRA({guid = 'a1a52edf-3541-4b55-bea4-58d4e1ab11dc', target_type='Surface_Contact_Unknown_Type', weapon_dbid=1575}, {'inherit','inherit','system','inherit'})

ScenEdit_SetDoctrineWRA({guid = 'a1a52edf-3541-4b55-bea4-58d4e1ab11dc', target_type='Surface_Contact_Unknown_Type', weapon_dbid=1575}, {'max','inherit',90,'inherit'})

ScenEdit_SetEMCON (type, name, emcon)

Sets the EMCON of the selected object. Select the object by specifying the type and the object's name.

Type is the type of object to set the EMCON on. It can be one of 4 values:

Side - Set an entire side's EMCON (e.g. United States using active radar)
Mission - Set the EMCON for a mission (e.g. Minesweepers active sonar)
Group - Set the EMCON for an entire group (e.g Package #20 active radar)
Unit - Set the EMCON for a single group (e.g. Hornet #14 passive radar)

emcon is a compound structure. The string follows the following grammar, with each clause separated by a semicolon (;)

Inherit indicates that the output EMCON should be at least the parent's EMCON. Inherit must come first.
A transmitter "set" statement. Each is of the form type=status, where type can be any one of Radar, Sonar, and OECM, and status can be any one of Passive or Active.

Parameters:

type string The type of the thing to set the EMCON on.
name string The name or GUID of the object to select.
emcon string The new EMCON for the object.

Usage:

ScenEdit_SetEMCON('Side', 'NATO', 'Radar=Active;Sonar=Passive')

ScenEdit_SetEMCON('Mission', 'ASW Patrol #1', 'Inherit;Sonar=Active')

ScenEdit_SetEMCON('Unit', 'Camel 2', 'OECM=Active')

ScenEdit_SetEvent (EventDescriptionOrID, options)

Sets the attributes of an event.

Parameters:

EventDescriptionOrID string The event name/GUID to perform operation on
options { EventUpdate } The event options

Returns:

{ table }

ScenEdit_SetEventAction (EventDescriptionOrID, options)

Sets the attributes of a T/C/A.

Parameters:

EventDescriptionOrID string The action name/GUID to perform operation on
options { EventTCAUpdate } The options

Returns:

{ table }

ScenEdit_SetEventCondition (EventDescriptionOrID, options)

Sets the attributes of a T/C/A.

Parameters:

EventDescriptionOrID string The condition name/GUID to perform operation on
options { EventTCAUpdate } The options

Returns:

{ table }

ScenEdit_SetEventTrigger (EventDescriptionOrID, options)

Sets the attributes of a T/C/A.

Parameters:

EventDescriptionOrID string The trigger name/GUID to perform operation on
options { EventTCAUpdate } The options

Returns:

{ table }

ScenEdit_SetKeyValue (key, value, forCampaign)

Sets the value for a key in the persistent key store.

This function allows you to add values, associated with keys, to a persistent store KeyStore that is retained when the game is saved and resumed. Keys and values are both represented as non-nil strings. The value is retrieved by ScenEdit_GetKeyValue.

Parameters:

key string The key to associate with
value string The value to associate
forCampaign bool Pass the store to next scenario in campaign. Optional, default = false

Usage:

ScenEdit_SetKeyValue("A","B")
ScenEdit_GetKeyValue("A") -- returns "B"

ScenEdit_SetLoadout (loadoutinfo)

Sets the loadout for a unit

Parameters:

loadoutinfo LoadoutInfo The loadout information to apply

Returns:

bool

ScenEdit_SetMine (side, guid, delay)

update a mine

Parameters:

side string} Side name or guid
guid string} Mine guid
delay integer The arming delay in seconds [optional]

Returns:

boolean

Usage:

local a = ScenEdit_SetMine({side='Blue', guid='cccccccc', [delay=99999]} )

ScenEdit_SetMission (SideName, MissionNameOrId, MissionOptions)

Set details for a mission.

Parameters:

SideName string The mission side
MissionNameOrId string The mission name
MissionOptions Mission The mission options as a table.

Returns:

Mission

Usage:

local mission = ScenEdit_SetMission('USA','CV CAP Left',{TankerUsage=1,OnStation=2})

ScenEdit_SetReferencePoint (descriptor)

Update a reference point(s) with new values.

Given a valid ReferencePointSelector as part of the descriptor, the function wil update the values contained in the descriptor. Values may be omitted from the descriptor if they are intended to remain unmodified. The 'area' selector is useful for changing some common attribute, like locking or highlighting, in bulk.

Additional key=value options are;
NEWNAME='string' to rename a reference point
TOGGLEHIGHLIGHTED = True to flip the reference point(s) highlight
CLEAR = True to remove the 'relative to' of the reference point(s)

Parameters:

descriptor ReferencePoint A valid selector with other values to update.

Returns:

ReferencePoint

Usage:

ScenEdit_SetReferencePoint({side="United States", name="Downed Pilot", lat=0.5})

ScenEdit_SetReferencePoint({side="United States", name="Downed Pilot", lat=0.5, lon="N50.50.50", highlighted = true})

ScenEdit_SetReferencePoint({side="United States", area={"rp-100","rp-101","rp-102","rp-103","rp-104"}, highlighted = true})

ScenEdit_SetScore (side, score, reason)

Sets a given side's score.

Parameters:

side string The name/GUID of the side
score num The new score for the side
reason string The reason for the score to change

Returns:

num

Usage:

ScenEdit_SetScore("PlayerSide", 20,"Reset score")

ScenEdit_SetSideOptions (options)

Set side options. ... AWARENESS and PROFICIENCY. (options)

Parameters:

options SideOptions The side items to be changed.

Returns:

{ SideOption }

Usage:

ScenEdit_SetSideOptions('{side='SideA',awareness='OMNI',PROFICIENCY='ace')

ScenEdit_SetSidePosture (sideAName, sideBName, posture)

Set the posture of a side towards another.

This will set side A's posture towards side B to the specified posture. This is the same as Stance, but only the first character of the name is used as shown in the table

Posture codes:

F	Friendly
H	Hostile
N	Neutral
U	Unfriendly

Parameters:

sideAName string Side A's name or GUID
sideBName string Side B's name or GUID
posture string The posture of side A towards side B

Returns:

boolean

Usage:

ScenEdit_SetSidePosture("LuaSideA", "LuaSideB", "H")

ScenEdit_SetSpecialAction (action_info)

Sets the properties of an existing special action.

Parameters:

action_info SpecialAction The special action to modify

ScenEdit_SetTime (new_time)

Sets the scenario time (UTC).

Parameters:

new_time string The desired UTC datetime as a table in MM:DD:YYYY & HH:MM:SS or MM.DD.YYYY & HH.MM.SS format

Usage:

ScenEdit_SetTime({Date="2.12.2007", Time="22.46.23"})

ScenEdit_SetTrigger (options)

Sets the attributes of a trigger.

Parameters:

options { TriggerUpdate } The trigger options

Returns:

{ table }

ScenEdit_SetUnit (unit)

Sets the properties of a unit that already exists.

Parameters:

unit Unit The unit to edit. Must be at least a selector.

Returns:

Unit

Usage:

ScenEdit_SetUnit({side="United States", unitname="USS Test", lat = 5})

ScenEdit_SetUnit({side="United States", unitname="USS Test", lat = 5})

ScenEdit_SetUnit({side="United States", unitname="USS Test", lat = 5, lon = "N50.20.10"})

ScenEdit_SetUnit({side="United States", unitname="USS Test", newname="USS Barack Obama"})

ScenEdit_SetUnit({side="United States", unitname="USS Test", heading=0, HoldPosition=1, HoldFire=1,Proficiency="Ace", Autodetectable="yes"})

ScenEdit_SetUnitDamage (options)

Set unit damage. ... for components on unit. (options)

Parameters:

options DamageOptions

Returns:

Component

Usage:

ScenEdit_SetUnitDamage({side='SideA', unitname='Ship', fires=1, components={ {'rudder','Medium'}, {'type',type='sensor',1} } })

ScenEdit_SetUnitSide (sidedesc)

Changes the side of a unit

Parameters:

sidedesc SideDescription The sides to change for the unit. Group will change attached units

Usage:

ScenEdit_SetUnitSide({side='Old Side', name='Eagle #1', newside='New Side'})

ScenEdit_SetWeather (temperature, rainfall, undercloud, seastate)

Set the current weather conditions.

This function takes four numbers that describe the desired weather conditions. These conditions are applied globally.

Parameters:

temperature number The current baseline temperature (in deg C). Varies by latitude.
rainfall number The rainfall rate, 0-50.
undercloud number The amount of sky that is covered in cloud, 0.0-1.0
seastate number The current sea state 0-9.

Returns:

boolean

Usage:

ScenEdit_SetWeather(math.random(0,25), math.random(0,50), math.random(0,10)/10.0, math.random(0,9))

ScenEdit_SetZone (sideName, zoneType, table)

update no-nav or exclusion zone.
... Only need to pass the parts to update

Parameters:

sideName string Side name/GUID
zoneType string Type of zone to remove: 0 = no-nav, 1 = exclusion
table { table } Description, Isactive, Area { of RPs }, Affects { of UnitTypes }, MarkAs (exc only), Locked (non only)

Returns:

{ Zone }

ScenEdit_SpecialMessage (side, message)

Displays a special message consisting of the HTML text message to side `side. Can include an optional location to jump to

Parameters:

side string The side name/guid to display the message on
message string The HTML text to display to the player

ScenEdit_TransferCargo (fromUnit, toUnit, cargoList)

Transfer cargo .. list from 'mother' to 'child'

Parameters:

fromUnit UnitSelector The unit with cargo
toUnit UnitSelector The unit to get cargo
cargoList { Cargo } List of cargo to transfer: table of {guids}, or { {number,DBID}, [{DBID}]}

Returns:

boolen

ScenEdit_UnitC ()

Detected Contact ... from a Unit Detected event trigger. Otherwise, a nil is returned.

Note that UnitC() can also be used as a shortcut for ScenEdit_UnitC()

Returns:

Contact

ScenEdit_UnitX ()

Activating Unit .. that triggered the current Event. Otherwise, a nil is returned.

Note that UnitX() can also be used as a shortcut for ScenEdit_UnitX()

Returns:

Unit

Usage:

ScenEdit_SetUnitDamage({side=UnitX().side, unitname=UnitX().name, fires=1, components={ {'rudder','Medium'}, {'type',type='sensor',1} } })

```
local unit = ScenEdit_UnitX()
```

ScenEdit_UnitY ()

Detecting Unit ... from a Unit Detected event trigger. Otherwise, a nil is returned.

Note that UnitY() can also be used as a shortcut for ScenEdit_UnitY()

Returns:

{ table }

Usage:

ScenEdit_SetUnitDamage({side=UnitY().side, unitname=UnitY().name, fires=1, components={ {'rudder','Medium'}, {'type',type='sensor',1} } })

local by = ScenEdit_UnitY()
 print('Y:'); print( by)
 print('Detected by: ');print( by.unit.name .. ' of type ' .. by.unit.type ..' from ' ..  by.unit.side)
 print('Sensor: ');print( by.sensor[1].name .. ' of type ' ..  by.sensor[1].type);

ScenEdit_UnloadCargo (fromUnit, cargoList)

Unload cargo

Parameters:

fromUnit UnitSelector The unit with cargo
cargoList { Cargo } List of cargo to unload: table of {guids}, or { { number, DBID}}

Returns:

boolen

ScenEdit_UpdateUnit (options)

Update items on a unit.

Parameters:

options UpdateUnit The unit sensor/mount/weapon details to update

Returns:

Unit

Usage:

ScenEdit_UpdateUnit({guid='2cd64757-1b66-4609-ad56-df41bee652e5',mode='add_sensor',dbid=3352})

ScenEdit_UpdateUnit({guid='2cd64757-1b66-4609-ad56-df41bee652e5',mode='remove_sensor',dbid=3352,sensorId='871aea14-d963-4052-a7fc-ed36e97bb732'})

ScenEdit_UpdateUnit({guid='2cd64757-1b66-4609-ad56-df41bee652e5',mode='delta',file='new.ini'})

ScenEdit_UpdateUnitCargo (options)

Update cargo on a unit.

Parameters:

options UpdateUnitCargo The unit cargo details to update

Returns:

Unit

Usage:

ScenEdit_UpdateUnitCargo({guid='2cd64757-1b66-4609-ad56-df41bee652e5', mode='add_cargo', cargo={{5, 752},{700}} })

ScenEdit_UpdateUnitCargo({guid='2cd64757-1b66-4609-ad56-df41bee652e5', mode='remove_cargo', cargo={'871aea14-d963-4052-a7fc-ed36e97bb732',{5, 752}} })

ScenEdit_UseAttachment (attachment)

Import an attachment into the scene.

Parameters:

attachment string Either the name of the attachment or the GUID of the attachment

ScenEdit_UseAttachmentOnSide (attachment, sidename)

Use an attachment on a side (used for .inst files as attachments).

Parameters:

attachment string Either the name of the attachment or the GUID of the attachment
sidename string The name of the side to import the attachment into

Tool_Bearing ()

Get bearing between points.

The points can be a GUID of a unit/contact or a latitude/longitude point.(fromHere, toHere)

Returns:

number

Usage:

Tool_Bearing('8269b881-20ce-4f2e-baa0-6823e46d55a4','004aa55d-d553-428d-a727-26853737c8f4' )

Tool_Bearing( {latitude='33.1991547589118', longitude='138.376876749942'}, '8269b881-20ce-4f2e-baa0-6823e46d55a4' )

Tool_DumpEvents ()

Dump scenario events. .. useful for checking. Also writes a file to the scenario folder()

Returns:

xml

Tool_EmulateNoConsole ()

Emulates no console. .. useful running event code in the console and seeing how it behaves as an 'event'(mode)

Returns:

boolean

Tool_Range ()

Get range between points.

The points can be a GUID of a unit/contact or a latitude/longitude point.(fromHere, toHere)

Returns:

number

Usage:

Tool_Range('8269b881-20ce-4f2e-baa0-6823e46d55a4','004aa55d-d553-428d-a727-26853737c8f4' )

Tool_Range( {latitude='33.1991547589118', longitude='138.376876749942'}, '8269b881-20ce-4f2e-baa0-6823e46d55a4' )

VP_ExportUnits (table, filename)

Export unit details

... to a file for later import parameters filename, filter by unit type, side

Parameters:

table table of Filters: TARGETSIDE, TARGETTYPE, TARGETSUBTYPE, SPECIFICUNITCLASS, SPECIFICUNIT. The values are like the Event Target triigers, but can take multiple ones. As in TargetType={'aircraft','submarine'}}
filename string of exported file

Returns:

bool

VP_GetContact (ContactGUID)

Get contact details This will get the information about a contact unit

Parameters:

ContactGUID VPContactSelector The contact selector to interrogate

Returns:

Contact

Usage:

local vp = VP_GetSide({name = "NATO"})
local cp = vp.contacts --List Of contacts
local guid = cp[12].objectid -- a specific contact
local contact = VP_GetContact({guid=guid}) -- details of contact as distinct to unit details

VP_GetSide (side)

Side information from player's perspective.

Gets a side object from the perspective of the player.

Parameters:

side SideSelector The side to get information about.

Returns:

Side

Usage:

local a = VP_GetSide({Side ='sidea'}) -- a side object
local z = a.nonavzones --List of no-nav zones for the side if you need to find it
local n = a : getnonavzone(z[1].guid) -- required zone object for a particular zone
n.isactive = false -- turn it off

VP_GetUnit (ActiveOrContact)

Get unit details This will get the information about an active unit or a contact unit

Parameters:

ActiveOrContact UnitSelector The unit selector to interrogate

Returns:

Unit

World_GetCircleFromPoint (table)

Returns a circle around point.

Parameters:

table Point

Returns:

Table of points

World_GetElevation (location)

Returns the elevation in meters of a given position

Parameters:

location Point The position to find the elevation of

Returns:

The elevation of the point in meters

World_GetLocation (location)

Returns table of details at a given position

Parameters:

location Point The position to find the details of

Returns:

table

World_GetPointFromBearing (table)

Returns a location based on bearing.

Parameters:

table Point

Returns:

Table of the new point

Tables

AAR

AAR. .. refueling options; these are updated by ScenEdit_SetMission()

Fields:

use_refuel_unrep string This is same as the one from Doctrine setting
tankerUsage string or number Automatic(0), Mission(1)
launchMissionWithoutTankersInPlace bool
tankerMissionList { mission name or guid } Table of missions to use as source of refuellers
tankerMinNumber_total number
tankerMinNumber_airborne number
tankerMinNumber_station number
maxReceiversInQueuePerTanker_airborne number
fuelQtyToStartLookingForTanker_airborne number Percentage of fuel (0-100)
tankerMaxDistance_airborne string or number Use 'internal' or set a range. The code will match the lowest availble setting

Cargo

Cargo.

.. in ship/air or dock facility

Fields:

guid string GUID
dbid number Database ID
name string Name
type number Type
status string Status
area number Cargo unit area
crew number Cargo unit crew
mass number Cargo unit mass
quantity number Items present
damage string Damage
statusR string Inoperative reason

CargoMission

CargoMission. .. options; these are updated by ScenEdit_SetMission()

Fields:

oneThirdRule bool True if activated
transitThrottleAircraft string
transitAltitudeAircraft string
stationThrottleAircraft string
stationAltitudeAircraft string
transitThrottleSubmarine string
transitDepthSubmarine string
stationThrottleSubmarine string
stationDepthSubmarine string
transitThrottleShip string
stationThrottleShip string
useFlightSize bool True if minimum size required
useGroupSize bool True if minimum size required
zone { name or guid } Table of reference point names and/or GUIDs

Component

Component.

This identifies the component/item(s) that are present in a unit. See Unit:filterOnComponent on how to filter this table

Fields:

comp_guid string GUID
comp_dbid string Database ID
comp_name string Name
comp_type string Type of component (mount, sensor, rudder, etc)
comp_status string Status
comp_statusR string Reason why inoperative [if not operational]
comp_damage string Damage Severity [if not operational]

EMmatch

EM matches .. details

Fields:

dbid number Databse id.
name string Matching id name.
category string Not applicable to weapons (Missile,Torpedo)
type string Not applicable to Facility
subtype number Type of item within the contact type ( subtype is "Fighter" within scope of Aircraft)
missile_defence number Applicable to Facility and Ships

Emissions

Contact emission .. details

Fields:

name string
age number Time detection held
solid string Precise detected (True/false)
sensor_dbid number Databse id.
sensor_name string Sensor name.
sensor_type string Sensor type
sensor_role string Sensor role
sensor_maxrange number Sensor range

Explosion

Defines the warhead to detonate.

Fields:

warheadid number The ID of the warhead to detonate
lat Latitude The latitude of the detonation
lon Longitude The longitude of the detonation
altitude Altitude The altitude of the detonation

Usage:

{warheadid=253, lat=unit.latitude, lon=unit.longitude, altitude=unit.altitude}

Facility

Facility.

.. air or dock facility

Fields:

guid string GUID
dbid number Database ID
name string Name
type number Type
status string Status
capacity number Units present

FerryMission

FerryMission. .. options; these are updated by ScenEdit_SetMission()

Fields:

ferryBehavior string Values OneWay(0), Cycle(1), Random(2)
ferryThrottleAircraft string
ferryAltitudeAircraft string
ferryTerrainFollowingAircraft bool
flightSize Size
minAircraftReq string
useFlightSize bool

Fuel

Fuel.

The various types of fuel(s), and their state, carried by the unit. Use ScenEdit_SetUnit() to set the fuel rather thane the unit.fuel... ScenEdit_SetUnit({...,fuel={{'GasFuel',1500},{2001,8000}}..}) It is easier and less prone to error; you can use the fuel name or the fuel number code

Fuel Types:

1001	'NoFuel'
2001	AviationFuel
3001	DieselFuel
3002	OilFuel
3003	GasFuel
4001	Battery
4002	AirIndepedent
5001	RocketFuel
5002	TorpedoFuel
5003	WeaponCoast

Fields:

fueltype { FuelState } The state of the type(s) of fuel in the unit. Note that the type is normally 4 digits. Use .fuels to get any breakdown of multiple tanks if present.

Usage:

local u = ScenEdit_GetUnit(...)
      local fuel = u.fuel
      fuel[3001].current = 400
      u.fuel = fuel

FuelState

Status of a fuel type.

Fields:

current number The current fuel level of the type
max number How much can be stored for the type
name string Name of the fuel

Usage:

local fuel = u.fuel
      fuel[3001].current = 400
      u.fuel = fuel

HostUnit

Requests that a unit be hosted/based to another

Fields:

HostedUnitNameOrID string The name or GUID of the unit to put into the host
SelectedHostNameOrID string The name or GUID of the host to put the unit into use SetUnit() with 'base=xxx' to assign the unit to a 'base'

LatLon

A Position on the map. ... is referred to with latitude (north/south) and longitude (east/west) coordinates. These can be represented in two forms, degrees minutes seconds, and decimal degrees. The Command Lua API supports both forms.

A set of latitude & longitude to define a point. Within the simulation, the values are recorded in decimal degrees.

Fields:

latitude number
longitude number

LoadoutInfo

Information on a loadout to add/alter

Fields:

UnitName string The name/GUID of the unit to change the loadout on
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 bool If the new loadout should rely on the magazines having the right weapons ready (default = false) (_optional_)
ExcludeOptionalWeapons bool 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 bool Deduct 'number' rather than add

Magazine

Magazine.

Note that when dealing with a magazine in a unit, it may constist of one or more actual magazine 'blocks'. This is what is being referred to here, rather than the ONE magazine group for the unit/group.

Fields:

mag_capacity string Capacity|Storage
mag_dbid string Database ID
mag_guid string GUID
mag_name string Name
mag_weapons { WeaponLoaded } Table of weapon loads in magazine

MineClearMission

MineClearMission. .. options; these are updated by ScenEdit_SetMission()

Fields:

oneThirdRule bool
transitThrottleAircraft string
transitAltitudeAircraft string
transitTerrainFollowingAircraft bool
stationThrottleAircraft string
stationAltitudeAircraft string
stationTerrainFollowingAircraft bool
transitThrottleSubmarine string
transitDepthSubmarine string
stationThrottleSubmarine string
stationDepthSubmarine string
transitThrottleShip string
stationThrottleShip string
flightSize Size
minAircraftReq string
useFlightSize bool
groupSize Size
useGroupSize bool
zone { name or guid } Table of reference point names and/or guids

MineMission

MineMission. .. options; these are updated by ScenEdit_SetMission()

Fields:

oneThirdRule bool
transitThrottleAircraft string
transitAltitudeAircraft string
transitTerrainFollowingAircraft bool
stationThrottleAircraft string
stationAltitudeAircraft string
stationTerrainFollowingAircraft bool
transitThrottleSubmarine string
transitDepthSubmarine string
stationThrottleSubmarine string
stationDepthSubmarine string
transitThrottleShip string
stationThrottleShip string
flightSize Size
minaircraftreq string
useFlightSize bool
groupSize Size
useGroupSize bool
zone { name or guid } Table of reference point names and/or guids
armingdelay time In format of 'days:hours:minutes:seconds' e.g. 1 day, 4 hours, 30 minutes would be '1:4:30:0'

Mount

Mount.

A mount is similar to a magazine, but it refers to the actual loads on the weapon, rather than a stoarge area.

Fields:

mount_dbid string Database ID
mount_guid string GUID
mount_name string Name
mount_status string Status
mount_statusR string Reason why inoperative [if not operational]
mount_damage string Damage Severity [if not operational]
mount_weapons { WeaponLoaded } Table of weapon loads on mount

PatrolMission

PatrolMission. .. options; these are updated by ScenEdit_SetMission()

Fields:

type string Subtype of mission (ASW = 'asw', ASuW_Naval = 'naval', AAW = 'aaw', ASuW_Land = 'land', ASuW_Mixed = 'mixed', SEAD = 'sead', SeaControl = 'sea')
oneThirdRule bool True if activated
checkOPA bool True if can investigate outside zones
checkWWR bool True if can investigate within weapon range
activeEMCON bool True if active EMCON in patrol zone
transitThrottleAircraft string
transitAltitudeAircraft string
transitTerrainFollowingAircraft bool True if terrain following
stationThrottleAircraft string
stationAltitudeAircraft string
stationTerrainFollowingAircraft bool True if terrain following
attackThrottleAircraft string
attackAltitudeAircraft string
attackTerrainFollowingAircraft bool True if terrain following
attackDistanceAircraft string
transitThrottleSubmarine string
transitDepthSubmarine string
stationThrottleSubmarine string
stationDepthSubmarine string
attackThrottleSubmarine string
attackDepthSubmarine string
attackDistanceSubmarine string
transitThrottleShip string
stationThrottleShip string
attackThrottleShip string
attackDistanceShip string
flightSize Size
minAircraftReq string
useFlightSize bool True if min size required
groupSize Size
useGroupSize bool True if min size required
prosecutionZone { name or guid } Table of reference point names and/or GUIDs
patrolZone { name or guid } Table of reference point names and/or GUIDs
FlightsToInvestigate string
FlightsToEngage string
WingmanEngageDistance string
BoatsToInvestigate string
BoatsToEngage string
GroupMemberEngageDistance string

SideContact

Side's contact.

Fields:

guid string The GUID of the contact. Note that this is not the GUID of the unit, you must use VP_GetUnit to resolve it.
name string The name of the contact.

SideDescription

Information on how to change a unit's side. ORDER IS IMPORTANT

Fields:

side string The original side
name string The name/GUID of the unit
newside string The new side

SideSelector

Information to select a particular side.

Fields:

GUID string The GUID of the side to select. Preferred.
Name string The name of the side to select.

SideUnit

Side's unit.

Fields:

guid string The GUID of the unit. This is the actual guid.
name string The name of the unit.

StrikeMission

StrikeMission. .. options; these are updated by ScenEdit_SetMission(). Note that these are split between the escorts and strikers

Fields:

type string Subtype of mission (Air_Intercept = 'air', Land_Strike = 'land', Maritime_Strike = 'sea', Sub_Strike = 'sub')
escortFlightSizeShooter Size
escortMinShooter number
escortMaxShooter number
escortResponseRadius number
escortUseFlightSize bool True if minimum size required
escortFlightSizeNonshooter Size
escortMinNonshooter number
escortMaxNonshooter number
escortGroupSize Size
escortUseGroupSize bool True if minimum size required
strikeOneTimeOnly bool True if activated
strikeMinimumTrigger string
strikeMax number
strikeFlightSize Size
strikeMinAircraftReq number
strikeUseFlightSize bool True if minimum size required
strikeGroupSize Size
strikeUseGroupSize bool True if minimum size required
strikeAutoPlanner bool True if activated
strikePreplan bool True if pre-planned target list only
strikeRadarUasge number Radar usage
strikeMinDistAircraft number Strike minimum distance
strikeMaxDistAircraft number Strike maximum distance
strikeMinDistShip number Strike minimum distance
strikeMaxDistShip number Strike maximum distance
FlightsToInvestigate string
FlightsToEngage string
WingmanEngageDistance string
BoatsToInvestigate string
BoatsToEngage string
GroupMemberEngageDistance string

SupportMission

SupportMission. .. options; these are updated by ScenEdit_SetMission()

Fields:

oneThirdRule bool
transitThrottleAircraft string
transitAltitudeAircraft string
transitTerrainFollowingAircraft bool
stationThrottleAircraft string
stationAltitudeAircraft string
stationTerrainFollowingAircraft bool
transitThrottleSubmarine string
transitDepthSubmarine string
stationThrottleSubmarine string
stationDepthSubmarine string
transitThrottleShip string
stationThrottleShip string
flightSize Size
minAircraftReq string
useFlightSize boo
groupSize Size
useGroupSize bool
zone { name or guid} Table of reference point names and/or guids
loopType string Values of ContinousLoop(0) or SingleLoop(1)
onStation string
oneTimeOnly bool
activeEMCON bool
tankerOneTime bool
tankerMaxReceivers string
ccenable string
ccallowqra string
ccflightgenmethod string
ccstationtime string
ccoverlap string

WRA

WRA settings. .. absence of fields implies that it is NOT used.

Fields:

qty_salvo string Weapons per salvo ('Max','DoNoUse' or a number)
shooter_salvo string Shooters per salvo ('Max','DoNoUse' or a number)
firing_range string Firing range ('Max','DoNoUse' or a number)
self_defence string Self-defence range ('Max','DoNoUse' or a number)

Waypoint

Waypoint .. describing the long/lat points as in a plotted course

Fields:

longitude number
latitude number
description string
presetAltitude string
presetDepth string
presetThrottle string
desiredAltitude number
desiredSpeed number
desiredAltitudeTF number terrain-following

WeaponLoaded

Weapon loads on mount or in magazine.

Fields:

wpn_guid string GUID
wpn_current string Current loads available
wpn_maxcap string Maximum loads
wpn_default string Default loads (to fill out)
wpn_name string Name
wpn_dbid string Database ID of weapon
wpn_type string Type of weapon

ZoneMarker

Zone marker.

fields are the same as a ReferencePoint marker

CommandLua

Contents

Reference

Topics

Examples

Module ScenEdit

Selector

Wrapper/Descriptor

Data types

Notes

Functions

Tables

Selector

Usage:

Wrapper/Descriptor

Usage:

Usage:

Usage:

Data types

Usage:

Notes

Functions

Returns:

Returns:

Parameters:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Returns:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Usage:

Parameters:

Returns:

Parameters:

Usage:

Usage:

Returns:

Usage:

Parameters:

Module `ScenEdit`