[Home] [Downloads] [Search] [Help/forum]

ArrayGetLastKey

Script function

world.ArrayGetLastKey

Read about scripting

Type

Method

Summary

Gets the key of the last element in the array (if any)

Prototype

VARIANT ArrayGetLastKey(BSTR Name);

View list of data type meanings

Description

This retrieves the key of the last element in a specified array. You can then use ArrayGet to get the value associated with that key.

You could use this to implement a stack (to pull out the last entry in the stack).


Available in MUSHclient version 3.46 onwards.



VBscript example

Note ArrayGetLastKey ("spells")


Lua example

Note (ArrayGetLastKey ("spells"))


Lua notes

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


Return value

The value of the last key for the specified array.

However if any of the following conditions is met, an "empty" variant is returned:

* Bad array name
* Array does not exist
* Array is empty


See Also ...

Topics

Arrays
Plugins
Scripting
Variables

Functions

(ArrayClear) Clears an array
(ArrayCount) Returns the number of arrays
(ArrayCreate) Creates an array
(ArrayDelete) Deletes an array
(ArrayDeleteKey) Deletes a key/value pair from an array
(ArrayExists) Tests to see if the specified array exists
(ArrayExport) Exports values from an array into a single string
(ArrayExportKeys) Exports keys from an array into a single string
(ArrayGet) Gets the value of an array item
(ArrayGetFirstKey) Gets the key of the first element in the array (if any)
(ArrayImport) Imports values into an array from a single string
(ArrayKeyExists) Tests to see if the specified array key exists
(ArrayListAll) Gets the list of arrays
(ArrayListKeys) Gets the list of all the keys in an array
(ArrayListValues) Gets the list of all the values in an array
(ArraySet) Sets the value of an array item
(ArraySize) Returns the number of elements in a specified array

(Help topic: function=ArrayGetLastKey)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]