DeleteAllMapItems
Script function

world.DeleteAllMapItems

DOC_scripting Read about scripting

Type

Method

Summary

Deletes the all items from the auto-mapper sequence.

Prototype

long DeleteAllMapItems();

DOC_data_types View list of data type meanings

Description

Deletes all items from the auto-mapper sequence.

You can use this to start a new auto-map sequence.

VBscript example

world.DeleteAllMapItems


Jscript example

world.DeleteAllMapItems();


PerlScript example

$world->DeleteAllMapItems();


Python example

world.DeleteAllMapItems


Lua example

DeleteAllMapItems()


Return value

eNoMapItems: Map sequence was empty, nothing was deleted.
eOK: Deleted all items


DOC_errors View list of return code meanings

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_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_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=DeleteAllMapItems)

DOC_contents Documentation contents page