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

This function Updates the values contained in the table. Values may be omitted if they are intended to remain unmodified.
The 'area' parameter is useful for changing some common attribute, like locking or highlighting,in bulk.
Don't include the 'area' parameter if only updating one RP.

Parameters

• table {}
  • guid = string The guid for the reference point
  • side = string The side the reference point is visible to
  • name = string The name of the reference point
  • newname = string The new name of the reference point
  • latitude = latitude The latitude of the reference point
  • longitude = longitude The longitude of the reference point
  • highlighted = True/False True if the point should be selected
  • locked = True/False True if the point is locked
  • bearing = number (0-360) Bearing from the 'relative' unit
  • bearingtype = typeFixed (0) or Rotating (1) Type of bearing
  • relativeto = string The unit name/guid that all the RP(s) relate to, if required
  • relativeto_contact = string The contact name/guid that all the RP(s) relate to, if required
  • relativeto_rp = string The RP name/guid that all the RP(s) relate to, if required
  • clear = True/False Remove the 'relative to' associated with the reference point(s)
  • area = { } of multiple A set of RPs to perform action on
    • 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 = 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 = type Fixed (0) or Rotating (1) Bearing aspect of the reference point

Returns

ReferencePointThe reference point object for the reference point or first one from the area list.

Example