Script function

world.EnableMapping

Type

Method

Summary

Enables or disables the auto-mapper

Prototype

void EnableMapping(boolean Enabled);

Description

Use this to enable or disable the inbuilt auto-mapper.

Available in MUSHclient version 3.47 onwards.

VBscript example

EnableMapping vbTrue

Jscript example

EnableMapping (true);

PerlScript example

EnableMapping (1);

Lua example

EnableMapping (true)

Lua notes

The enabled flag is optional, and defaults to true.

Return value

Nothing.

See Also ...

Topics

Aliases
Auto-mapper
Speed walking

Functions

(AddMapperComment) Adds a comment to the auto-map sequence
(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

(Help topic: function=EnableMapping)