Script function
world.AddToMapper
Read about scripting
Type
Method
Summary
Adds a mapping direction to the auto-map sequence
Prototype
long AddToMapper(BSTR Direction, BSTR Reverse);
View list of 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
View list of return code meanings
See Also ...
Topics
Aliases
Auto-mapper
Speed walking
Functions
(AddMapperComment) Adds a comment to the auto-map sequence
(DeleteAllMapItems) Deletes the all items from the auto-mapper sequence.
(DeleteLastMapItem) Deletes the most recently-added item from the auto-mapper sequence.
(EnableMapping) Enables or disables the auto-mapper
(GetMappingCount) Gets a count of the number of items in the auto-map sequence
(GetMappingItem) Gets one item from the auto-map sequence
(GetMappingString) Returns the speedwalk string generated by the auto-mapper.
(Mapping) A flag to indicate whether we are mapping the world
(RemoveMapReverses) A flag to indicate whether we backtracks are removed during mapping
(Help topic: function=AddToMapper)