Difference between revisions of "LlGetInventoryName"

From Second Life Wiki
Jump to navigation Jump to search
m (added LSL Tip)
(Simplify the example while improving its functionality. Remove irrelevant "tip")
Line 7: Line 7:
|func_footnote=
|func_footnote=
Inventory items are sorted in alphabetical order (not chronological order).
Inventory items are sorted in alphabetical order (not chronological order).
{{LSL Tip|Please read [[User:Kireji_Haiku/How_to_deal_with_lists_in_LSL|this intro of how to iterate over a list in LSL]].}}
|func_desc
|func_desc
|return_text=that is the name of the inventory item {{LSLP|number}} of {{LSLP|type}}. Returns an empty string if no item of the specified type is found in the prim's inventory (or there are less than or equal to {{LSLP|number}} items of the type).
|return_text=that is the name of the inventory item {{LSLP|number}} of {{LSLP|type}}. Returns an empty string if no item of the specified type is found in the prim's inventory (or there are less than or equal to {{LSLP|number}} items of the type).
Line 15: Line 14:
|examples======Box Unpacker=====
|examples======Box Unpacker=====
<lsl>
<lsl>
// script created by SpiritWolf Chikuwa
// Give all prim contents to anyone touching this object,
//  minor changes by Strife Onizuka to speed things up
// But don't give this script itself.
//
//  This script is public domain.
//  You can copy, modify or transfer.
// Please, do not resell this script but give it full perms for free.
//  Please keep this header intact.
//
//  Minor changes: (insert your name here and delete this comment if you do any mod of this script, thank you)
//
// Script start here:
 
list listOfInventoryItems;
 
update_inventory_items_list()
{
//  empty the list
    listOfInventoryItems = [];
 
//  get the total number of items
    integer numberOfItems = llGetInventoryNumber(INVENTORY_ALL);
 
//  get names of inventory items
//  index is 0 to (total - 1)
    integer index;
    do
    {
        listOfInventoryItems += [llGetInventoryName(INVENTORY_ALL, index)];
    }
    while (++index < numberOfItems);
}


default
default
{
{
    changed(integer change)
    {
      if (change & CHANGED_INVENTORY)
          update_inventory_items_list();
    }
    state_entry()
    {
        update_inventory_items_list();
    }
     touch_start(integer num_detected)
     touch_start(integer num_detected)
     {
     {
         key avatarKey = llDetectedKey(0);
         list    InventoryList;
         string folderName = llGetObjectName();
        integer count = llGetInventoryNumber(INVENTORY_ALL); // Count of all items in prim's contents
 
         string ItemName;
         llGiveInventoryList(avatarKey, folderName, listOfInventoryItems);
        while (count--)
        {
            ItemName = llGetInventoryName(INVENTORY_ALL, count);
            if (ItemName != llGetScriptName() ) 
                InventoryList += ItemName;   // add all contents except this script, to a list
        }
        // Give all the items to the toucher, in a folder named as per this prim's name
         llGiveInventoryList(llDetectedKey(0), llGetObjectName(), InventoryList);
     }
     }
}
}

Revision as of 10:42, 7 January 2013

Summary

Function: string llGetInventoryName( integer type, integer number );
0.0 Forced Delay
10.0 Energy

Returns a string that is the name of the inventory item number of type. Returns an empty string if no item of the specified type is found in the prim's inventory (or there are less than or equal to number items of the type).

• integer type – INVENTORY_* flag
• integer number – Beginning from 0

number does not support negative indexes. Inventory items are sorted in alphabetical order (not chronological order).

Flag Inventory Type
INVENTORY_NONE -1 Item does not exist.
INVENTORY_ALL Any inventory type.
INVENTORY_TEXTURE 0 texture
INVENTORY_SOUND 1 sound
INVENTORY_LANDMARK 3 landmark
INVENTORY_CLOTHING 5 clothing
INVENTORY_OBJECT 6 object
Flag Inventory Type
INVENTORY_NOTECARD 7 notecard
INVENTORY_SCRIPT 10 script
INVENTORY_BODYPART 13 body part
INVENTORY_ANIMATION 20 animation
INVENTORY_GESTURE 21 gesture
INVENTORY_SETTING 56 setting
INVENTORY_MATERIAL 57 material

Caveats

  • If number is out of bounds the script continues to execute without an error message.

Examples

Box Unpacker

<lsl> // Give all prim contents to anyone touching this object, // But don't give this script itself.

default { 

   touch_start(integer num_detected)
   {
       list    InventoryList;
       integer count = llGetInventoryNumber(INVENTORY_ALL);  // Count of all items in prim's contents
       string  ItemName;
       while (count--)
       {
           ItemName = llGetInventoryName(INVENTORY_ALL, count);
           if (ItemName != llGetScriptName() )  
               InventoryList += ItemName;   // add all contents except this script, to a list
       }
       // Give all the items to the toucher, in a folder named as per this prim's name
       llGiveInventoryList(llDetectedKey(0), llGetObjectName(), InventoryList);
   }

}

</lsl>

Notes

The maximum number of characters for an object inventory item is currently 63 characters.

See Also

Functions

•  llGetInventoryNumber – Returns the number of items of a specific type in inventory
•  llGetInventoryType – Tests to see if an inventory item exists and returns its type.
•  llGetInventoryCreator – Returns the inventory item's creator
•  llGetInventoryPermMask – Returns the inventory item's permissions
•  llGetInventoryKey – Returns the inventory item's UUID (if full perm)

Deep Notes

Tests

•  llGiveInventory_All_Test

Signature

function string llGetInventoryName( integer type, integer number );
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlGetInventoryName&oldid=1175931"