Register forum user name Search FAQ

DeleteAllMapItems

Script function

world.DeleteAllMapItems

Read about scripting

Type

Method

Summary

Deletes the all items from the auto-mapper sequence.

Prototype

long DeleteAllMapItems();

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

View list of return code meanings

See Also ...

Topics

Aliases
Auto-mapper
Speed walking

Functions

(AddMapperComment) Adds a comment to the auto-map sequence
(AddToMapper) Adds a mapping direction to the auto-map sequence
(DeleteLastMapItem) Deletes the most recently-added item from the auto-mapper sequence.
(EnableMapping) Enables or disables the auto-mapper
(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.
(Mapping) A flag to indicate whether we are mapping the world
(RemoveMapReverses) A flag to indicate whether we backtracks are removed during mapping

(Help topic: function=DeleteAllMapItems)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.