GetMappingItem
Script function

world.GetMappingItem

DOC_scripting Read about scripting

Type

Method

Summary

Gets one item from the auto-map sequence

Prototype

VARIANT GetMappingItem(long Item);

DOC_data_types View list of data type meanings

Description

Returns one item from the auto-map sequence. You supply the item number that you want.

It should be in the range zero to the value returned by GetMappingCount, minus 1. If not, a NULL variant will be returned.

The item number is zero relative, so that if you have two items in the map sequence, they will be:

0: first item
1: second item

The returned value is a single string, with the forwards and reverse direction separated by a slash. For example:

north/south

VBscript example

world.note world.GetMappingItem (0)


Jscript example

world.note(world.GetMappingItem(0));


PerlScript example

$world->note($world->GetMappingItem(0));


Python example

world.note(world.GetMappingItem(0))


Lua example

Note(GetMappingItem(0))


Lua notes

Lua returns nil where applicable instead of an "empty variant" or "null variant".


Return value

If the item number is less than zero, or greater than, or equal to, the number returned by GetMappingCount, then a NULL variant will be returned.

Otherwise, the contents of the appropriate map item will be returned. The forwards and reverse direction will be separated by the "/" character.



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

DOC_contents Documentation contents page