MUSHclient scripting

Description of MUSHclient world function: world.DeleteAllMapItems

Name	DeleteAllMapItems
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()`
Returns	`eNoMapItems: Map sequence was empty, nothing was deleted. eOK: Deleted all items` View list of return code meanings

See also ...

Function	Description
AddToMapper	Adds a mapping direction to the auto-map sequence
DeleteLastMapItem	Deletes the most recently-added item from the auto-mapper sequence.
GetMappingCount	Gets a count of the number of items in 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

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

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