Reference Forum

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

ScenEdit_AddZone (sideName, zoneType, table)

This function creates a non-navigation or exclusion zone.
The Reference Points are normally visible to the side. They can start out 'hidden' by adding 'hidden=1' to the table options.

Parameters

• table {}
  • sideName = string The Side name/GUID. Custom environment zones are always added to the Nature side.
  • zoneType = number0 = non-navigation, 1 = exclusion, 2 = custom environment, -925 = standard The type of zone to add
  • description = string The Zone name
  • isactive = True/False Is the zone active?
  • locked = True/False Are Zone RPs locked?
  • hidden = True/False Are Zone RPs hidden?
  • affects = table {}list of core unit types ('SHIP', 'AIRCRAFT', etc) affected Zone applies to these core unit types
  • markAs = posture Units entering the zone are treated as (posture towards them) [exclusion zone only]
  • relativeto = string The unit name/guid that all the RP(s) relate to, if required
  • area = {} of multiple The area defining the zone
    • name = string The name of the new reference point
    • latitude = latitude The latitude of the new reference point
    • longitude = longitude The longitude of the new reference point
    • highlighted = True/False True if the reference point should be selected
    • locked = True/False True if the reference point is locked
    • distance = distance Distance from the 'relative' unit
    • bearing = number (0-360) Bearing from the 'relative' unit
    • bearingtype = bearingFixed (0) or Rotating (1) Bearing aspect of the reference point

Returns

Zone The zone as a wrapper

Example