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

MUSHclient scripting

Description of MUSHclient world function: world.Mapping

Name Mapping
Type Property
Summary A flag to indicate whether we are mapping the world
Prototype boolean Mapping;

View list of data type meanings


This property controls whether automatic mapping takes place as you walk around.

VBscript example
world.note world.Mapping
Jscript example
PerlScript example
$world->note ($world->{Mapping});
Python example
Lua example
Note(GetMapping ())
SetMapping (false)
Lua notes
Lua implements this as two functions:

GetMapping - gets whether mapping occurs
SetMapping - sets whether mapping occurs

The argument is optional, and defaults to true.
Returns TRUE if mapping is enabled
FALSE if mapping is NOT enabled

Note: TRUE is a non-zero value, FALSE is the value 0.

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.
RemoveMapReverses A flag to indicate whether we backtracks are removed during mapping

Search for script function

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.

Search for:   

Leave blank to show all functions.

Return codes

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

You can view a list of the return codes

Function prototypes

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

You can view a list of the data types used in function prototypes

View all functions


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.


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]