Back to index...

NameTypeDeprecatedSecureDescription
Command.Map.MonitorfunctionControls the state of the map monitor flag. When enabled, mainmap data will be received, updating...
Command.Map.Waypoint.ClearfunctionClears the player's current waypoint.
Command.Map.Waypoint.SetfunctionSets the player's waypoint.
Event.Map.AddSignals the addition of a map element.
Event.Map.ChangeSignals the change of a map element, in some manner besides coordinates.
Event.Map.Detail.CoordSignals the coordinate change of a map element.
Event.Map.RemoveSignals the removal of a map element.
Event.Map.Waypoint.UpdateSignals the change of a player's waypoint.
Inspect.Map.DetailfunctionReturns information about map locations.
Inspect.Map.ListfunctionReturns a table of map locations.
Inspect.Map.MonitorfunctionInspects the state of the map monitor flag. See Command.Map.Monitor() for details.
Inspect.Map.Waypoint.GetfunctionGets a unit's current waypoint.

Command.Map.Monitor

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)
ParameterTypeDatatypeDescription
monitorparameterbooleanThe new state of the map monitor flag.

Command.Map.Waypoint.Clear

Clears the player's current waypoint.

Usage:

Command.Map.Waypoint.Clear()

Command.Map.Waypoint.Set

Sets the player's waypoint.

Usage:

Command.Map.Waypoint.Set(x, z)
ParameterTypeDatatypeDescription
xparameternumberThe x coordinate of the waypoint.
zparameternumberThe z coordinate of the waypoint.

Event.Map.Add

Signals the addition of a map element.

Usage:

Event.Map.Add(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Change

Signals the change of a map element, in some manner besides coordinates.

Usage:

Event.Map.Change(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Detail.Coord

Signals the coordinate change of a map element.

Usage:

Event.Map.Detail.Coord(x, y, z)
ParameterTypeDatatypeDescription
xparametervariantThe new X coordinate of the changed elements. Takes the form of a table. The key is the element ID.
yparameter<nope>The new Y coordinate of the changed elements. Takes the form of a table. The key is the element ID.
zparameter<nope>The new Z coordinate of the changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Remove

Signals the removal of a map element.

Usage:

Event.Map.Remove(elements)
ParameterTypeDatatypeDescription
elementsparametervariantThe changed elements. Takes the form of a table. The key is the element ID.

Event.Map.Waypoint.Update

Signals the change of a player's waypoint.

Usage:

Event.Map.Waypoint.Update(units)
ParameterTypeDatatypeDescription
unitsparametervariantThe unit whose waypoint has changed. Takes the form of a table. The key is the element ID.

Inspect.Map.Detail

Returns information about map locations.

Usage:

detail = Inspect.Map.Detail(location)
details = Inspect.Map.Detail(locations)
ParameterTypeDatatypeDescription
locationparameterlocationThe identifier of the location to retrieve detail for.
locationsparametertableA table of identifiers of locations to retrieve detail for.
detailresulttableDetail table for a single location.
detailsresulttableDetail 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.

Inspect.Map.List

Returns a table of map locations.

Usage:

list = Inspect.Map.List()
ParameterTypeDatatypeDescription
listresulttableValid locations, in {id = true} format.

Inspect.Map.Monitor

Inspects the state of the map monitor flag. See Command.Map.Monitor() for details.

Usage:

monitor = Inspect.Map.Monitor()
ParameterTypeDatatypeDescription
monitorresultbooleanThe current state of the map monitor flag.

Inspect.Map.Waypoint.Get

Gets a unit's current waypoint.

Usage:

x, z = Inspect.Map.Waypoint.Get(unit)
ParameterTypeDatatypeDescription
unitparameterunitA unit, in either unit ID or unit specifier format.
xresultnumberThe x coordinate of the waypoint.
zresultnumberThe z coordinate of the waypoint.

Back to index...