AddMapperComment
Script function

world.AddMapperComment

DOC_scripting Read about scripting

Type

Method

Summary

Adds a comment to the auto-map sequence

Prototype

long AddMapperComment(BSTR Comment);

DOC_data_types 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")


Return value

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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_aliases Aliases
DOC_mapper Auto-mapper
DOC_speed_walking Speed walking

Functions

FNC_AddToMapper AddToMapper (Adds a mapping direction to the auto-map sequence)
FNC_DeleteAllMapItems DeleteAllMapItems (Deletes the all items from the auto-mapper sequence.)
FNC_DeleteLastMapItem DeleteLastMapItem (Deletes the most recently-added item from the auto-mapper sequence.)
FNC_EnableMapping EnableMapping (Enables or disables the auto-mapper)
FNC_GetMappingCount GetMappingCount (Gets a count of the number of items in the auto-map sequence)
FNC_GetMappingItem GetMappingItem (Gets one item from the auto-map sequence)
FNC_GetMappingString GetMappingString (Returns the speedwalk string generated by the auto-mapper.)
FNC_Mapping Mapping (A flag to indicate whether we are mapping the world)
FNC_RemoveMapReverses RemoveMapReverses (A flag to indicate whether we backtracks are removed during mapping)

(Help topic: function=AddMapperComment)

DOC_contents Documentation contents page