world.AddMapperComment

MUSHclient script function (Method)

Adds a comment to the auto-map sequence

Prototype

long AddMapperComment(BSTR Comment);

Data type meanings

Description

Adds a comment to the auto-map sequence. This lets you put comments into the map sequence (eg. the name of the current room).

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.AddMapperComment "Main Square"

Jscript example

world.AddMapperComment ("Main Square");

PerlScript example

$world->AddMapperComment("Main Square");

Python example

world.AddMapperComment ("Main Square")

Lua example

AddMapperComment ("Main Square")

Return value

eBadMapItem: comment may not contain "{", "}", "(", ")", "/" or "\"
eOK: added OK

Return code meanings

Function	Description
AddToMapper	Adds a mapping direction 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.
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