Controls the state of the map monitor flag. When enabled, mainmap data will be received, updating every sixty seconds. When disabled, mainmap data will be received only when the built-in map window is open.
Usage:
| Command.Map.Monitor(monitor) |
| Parameter | Type | Datatype | Description |
|---|
| monitor | parameter | boolean | The new state of the map monitor flag. |
Signals the addition of a map element.
Usage:
| Event.Map.Add(elements) |
| Parameter | Type | Datatype | Description |
|---|
| elements | parameter | variant | The changed elements. Takes the form of a table. The key is the element ID. |
Signals the change of a map element, in some manner besides coordinates.
Usage:
| Event.Map.Change(elements) |
| Parameter | Type | Datatype | Description |
|---|
| elements | parameter | variant | The changed elements. Takes the form of a table. The key is the element ID. |
Signals the coordinate change of a map element.
Usage:
| Event.Map.Detail.Coord(x, y, z) |
| Parameter | Type | Datatype | Description |
|---|
| x | parameter | variant | The new X coordinate of the changed elements. Takes the form of a table. The key is the element ID. |
| y | parameter | <nope> | The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID. |
| z | parameter | <nope> | The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID. |
Signals the removal of a map element.
Usage:
| Event.Map.Remove(elements) |
| Parameter | Type | Datatype | Description |
|---|
| elements | parameter | variant | The changed elements. Takes the form of a table. The key is the element ID. |
Returns information about map locations.
Usage:
| detail = Inspect.Map.Detail(location) |
| details = Inspect.Map.Detail(locations) |
| Parameter | Type | Datatype | Description |
|---|
| location | parameter | location | The identifier of the location to retrieve detail for. |
| locations | parameter | table | A table of identifiers of locations to retrieve detail for. |
| detail | result | table | Detail table for a single location. |
| details | result | table | Detail tables for all requested locations. The key is the location ID, the value is the location's detail table. |
- members
-
| coordX |
The map location's current X coordinate.
|
| coordY |
The map location's current Y coordinate.
|
| coordZ |
The map location's current Z coordinate.
|
| description |
The description of this map location, if it has one.
|
| id |
The ID of the requested element.
|
| title |
The title of this map location, if it has one.
|
Returns a table of map locations.
Usage:
| list = Inspect.Map.List() |
| Parameter | Type | Datatype | Description |
|---|
| list | result | table | Valid locations, in {id = true} format. |
Inspects the state of the map monitor flag. See Command.Map.Monitor() for details.
Usage:
| monitor = Inspect.Map.Monitor() |
| Parameter | Type | Datatype | Description |
|---|
| monitor | result | boolean | The current state of the map monitor flag. |