From 858e732e15c495f3073c8037b9612c6c20390f76 Mon Sep 17 00:00:00 2001 From: EyesOfAHawk Date: Thu, 28 Feb 2019 21:15:57 +1300 Subject: Adds BUILDIN(delitemidx), which deletes an item at the given index. Signed-off-by: Haru --- doc/script_commands.txt | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'doc') diff --git a/doc/script_commands.txt b/doc/script_commands.txt index c3cc8a799..065b75c2b 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -5317,6 +5317,34 @@ Check getitem2() to understand its expanded parameters. --------------------------------------- +*delitemidx({, {, }}) + +This command will remove an item at the given inventory index. Unlike the +'delitem()' counterpart, this doesn't check invalid Item ID, making it useful to remove +invalid item IDs in player's inventory. + +If is not specified, this will remove all of the items at the specified index. +Note that items with the 'ForceSerial' flag, not yet merged through 'mergeitem()', will only +be removed at the given index. + +The only way to get the inventory index is by using 'getinventorylist()'. After deleting +an item at the given index, that index can remain empty until the player relogs, so you +should recall 'getinventorylist()' again. If you try to delete an item at an invalid index, the +script will terminate with an error. + +This command is also useful to remove rental/bound items because 'delitem()' +does not discriminate at choosing which item to remove. + +Example: + + // This will remove all invalid Item ID in player's inventory + getinventorylist(); + for (.@i = 0; .@i < @inventorylist_count; ++.@i) + if (getiteminfo(@inventorylist_id[.@i], ITEMINFO_TYPE) == -1) + delitemidx(@inventorylist_idx[.@i]); + +--------------------------------------- + *countitem() *countitem("") -- cgit v1.2.3-70-g09d2