[Home] [Downloads] [Search] [Help/forum]

AddMapperComment

Script function

world.AddMapperComment

Read about scripting

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


Return value

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

View list of return code meanings

See Also ...

Topics

Aliases
Auto-mapper
Speed walking

Functions

(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.
(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=AddMapperComment)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]