EnableMapping
Script function

world.EnableMapping

DOC_scripting Read about scripting

Type

Method

Summary

Enables or disables the auto-mapper

Prototype

void EnableMapping(boolean Enabled);

DOC_data_types View list of data type meanings

Description

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

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

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_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_Mapping Mapping (A flag to indicate whether we are mapping the world)
FNC_RemoveMapReverses RemoveMapReverses (A flag to indicate whether we backtracks are removed during mapping)

(Help topic: function=EnableMapping)

DOC_contents Documentation contents page