Mapping
Script function

world.Mapping

DOC_scripting Read about scripting

Type

Property

Summary

A flag to indicate whether we are mapping the world

Prototype

boolean Mapping;

DOC_data_types View list of 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.



See Also ...

Topics

DOC_aliases Aliases
DOC_mapper Auto-mapper
DOC_speed_walking Speed walking

Functions

FNC_AddMapperComment AddMapperComment (Adds a comment to the auto-map sequence)
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_RemoveMapReverses RemoveMapReverses (A flag to indicate whether we backtracks are removed during mapping)

(Help topic: function=Mapping)

DOC_contents Documentation contents page