MUSHclient scripting

Description of MUSHclient world function: world.AddMapperComment

Name	AddMapperComment
Type	Method
Summary	Adds a comment to the auto-map sequence
Prototype	`long AddMapperComment(BSTR Comment);` View list of 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")`
Returns	`eBadMapItem: comment may not contain "{", "}", "(", ")", "/" or "\" eOK: added OK` View list of return code meanings

See also ...

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

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.