world.Mapping

MUSHclient script function (Property)

A flag to indicate whether we are mapping the world

Prototype

boolean Mapping;

Data type meanings

Description

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

VBscript example

world.note world.Mapping

Jscript example

world.note(world.Mapping);

PerlScript example

$world->note ($world->{Mapping});

Python example

world.note(world.Mapping)

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.

Return value

TRUE if mapping is enabled
FALSE if mapping is NOT enabled

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

Related topic

Auto-mapper

See also