#Lua SEXPs

$Operator: lua-prox-set-enabled
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 1
$Maximum Arguments: 1
$Return Type: Nothing
$Description: Sets whether the proximity monitor is displayed
$Parameter:
	+Description: True to enable, false to disable
	+Type: boolean

$Operator: lua-prox-set-distances
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 3
$Maximum Arguments: 3
$Return Type: Nothing
$Description: Sets the distance thresholds used by the proximity monitor.
$Parameter:
	+Description: Minimum distance (below which the bar appears in red)
	+Type: number
$Parameter:
	+Description: Safe distance (below which the bar appears in yellow)
	+Type: number
$Parameter:
	+Description: Maximum distance (below which the bar appears in green, and above which the bar is not displayed)
	+Type: number

$Operator: lua-prox-set-safe-range
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 2
$Maximum Arguments: 2
$Return Type: Nothing
$Description: If set, the proximity monitor will not be shown within range of the specified object.
$Parameter:
	+Description: Ship or waypoint at the center of the effective region
	+Type: ship+waypoint
$Parameter:
	+Description: Radius beyond which the proximity monitor will display ships
	+Type: number

$Operator: lua-prox-clear-safe-range
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 0
$Maximum Arguments: 0
$Return Type: Nothing
$Description: Clears the behavior from lua-prox-set-safe-range.

$Operator: lua-prox-add-ships
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 1
$Return Type: Nothing
$Description: Adds ships to be tracked by the proximity monitor
$Repeat
$Parameter:
	+Description: A ship
	+Type: shipname

$Operator: lua-prox-remove-ships
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 1
$Return Type: Nothing
$Description: Removes ships from the proximity monitor
$Repeat
$Parameter:
	+Description: A ship
	+Type: shipname

$Operator: lua-prox-remove-all-ships
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 0
$Maximum Arguments: 0
$Return Type: Nothing
$Description: Removes all ships from the proximity monitor

$Operator: lua-prox-set-sort-direction
$Category: Change
$Subcategory: Proximity Monitor
$Minimum Arguments: 1
$Maximum Arguments: 1
$Return Type: Nothing
$Description: Sets whether the ships displayed on the proximity monitor are sorted.  A number below zero means sort descending, a number above zero means sort ascending, and zero means keep the order the ships were added
$Parameter:
	+Description: Sort direction
	+Type: number

#End
