world.AddToMapper

MUSHclient script function (Method)

Adds a mapping direction to the auto-map sequence

Prototype

long AddToMapper(BSTR Direction, BSTR Reverse);

Data type meanings

Description

Adds a new direction to the auto-map sequence. You specify both the forward direction, and the reverse direction (the one taken when going backwards).

For example if you are going North, then the reverse direction is (usually) South.

Note, mapping does *not* need to be enabled to use this method. This lets you use triggers or aliases to build up a map direction, rather than MUSHclient's automatic mapping.

VBscript example

world.AddToMapper "north", "south"
world.AddToMapper "enter", "leave"

Jscript example

world.AddToMapper("north", "south");
world.AddToMapper("enter", "leave");

PerlScript example

$world->AddToMapper("north", "south");
$world->AddToMapper("enter", "leave");

Python example

world.AddToMapper("north", "south")
world.AddToMapper("enter", "leave")

Lua example

AddToMapper("north", "south")
AddToMapper("enter", "leave")

Lua notes

The reverse direction is optional.

Return value

eBadMapItem: direction (or reverse direction) may not contain "{", "}", "(", ")", "/" or ""
eBadMapItem: forward and reverse direction cannot both be empty
eOK: added OK

Return code meanings

Related topic

Auto-mapper

See also