Difference between revisions of "LlGetInventoryDesc"

From Second Life Wiki
Jump to navigation Jump to search
(Copied the definition of llGetInventoryName() and modified.)
 
m (This function returns a string, not a key.)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|func_id
|inject-2={{LSL_Function/inventory|item|uuid=false}}
|mode=request
|func_id=0|func_sleep=0.0|func_energy=10.0
|func_sleep=0.0
|func_energy=10.0
|func=llGetInventoryDesc
|func=llGetInventoryDesc
|return_type=string
|return_type=string
|p1_type=integer|p1_name=type|p1_desc=INVENTORY_* flag
|p1_type=string|p1_name=item
|p2_type=integer|p2_name=number
|sort=GetInventoryDesc
|func_footnote
|func_footnote
|func_desc
|func_desc
|return_text=that is the description 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.
|return_text=with the description of the inventory {{LSLP|item}}.
|spec
|spec
|caveats
|caveats=
|constants={{LSL Constants Inventory}}
* If {{LSLP|item}} has no description an empty string is returned.
|examples
|constants
|examples=Add an object to a prims inventory, as well as this script, in order to get the name of the creator.
<source lang="lsl2">default
{
    touch_start(integer total_number)
    {
        integer count = llGetInventoryNumber(INVENTORY_ALL);
        integer index;
        for (index = 0; index < count; ++index)
        {
            string name = llGetInventoryName(INVENTORY_ALL, index);
            string desc = llGetInventoryDesc(name);
           
            llSay(0, "Item: \"" + name + "\" -- \"" + desc + "\"");
        }
    }
}
</source>
|helpers
|helpers
|also_functions=
|also_functions=
{{LSL DefineRow||[[llGetInventoryAcquireTime]]|Returns the time the item was added to the prim's inventory}}
{{LSL DefineRow||[[llGetInventoryName]]|Returns the inventory item's name}}
{{LSL DefineRow||[[llGetInventoryName]]|Returns the inventory item's name}}
{{LSL DefineRow||[[llGetInventoryType]]|Tests to see if an inventory item exists and returns its type}}
{{LSL DefineRow||[[llGetInventoryNumber]]|Returns the number of items of a specific type in inventory}}
{{LSL DefineRow||[[llGetInventoryNumber]]|Returns the number of items of a specific type in inventory}}
{{LSL DefineRow||[[llGetInventoryType]]|Tests to see if an inventory item exists and returns it's type.}}
{{LSL DefineRow||[[llGetInventoryCreator]]|Returns the inventory item's creator}}
{{LSL DefineRow||[[llGetInventoryPermMask]]|Returns the inventory item's permissions}}
{{LSL DefineRow||[[llGetInventoryPermMask]]|Returns the inventory item's permissions}}
{{LSL DefineRow||[[llGetInventoryKey]]|Returns the inventory item's [[UUID]] (if full perm)}}
{{LSL DefineRow||[[llGetInventoryKey]]|Returns the inventory item's [[UUID]] (if full perm)}}
Line 27: Line 42:
|also_articles
|also_articles
|notes
|notes
|permission
|sort=GetInventoryDesc
|cat1=Inventory
|cat1=Inventory
|cat2
|cat2

Latest revision as of 13:01, 9 December 2023

Summary

Function: string llGetInventoryDesc( string item );

Returns a string with the description of the inventory item.

• string item an item in the inventory of the prim this script is in

Caveats

  • If item is missing from the prim's inventory then an error is shouted on DEBUG_CHANNEL.
  • If item has no description an empty string is returned.
All Issues ~ Search JIRA for related Bugs

Examples

Add an object to a prims inventory, as well as this script, in order to get the name of the creator.

default
{
    touch_start(integer total_number)
    {
        integer count = llGetInventoryNumber(INVENTORY_ALL);
        integer index;
        for (index = 0; index < count; ++index)
        {
            string name = llGetInventoryName(INVENTORY_ALL, index);
            string desc = llGetInventoryDesc(name);
            
            llSay(0, "Item: \"" + name + "\" -- \"" + desc + "\"");
        }
    }
}

See Also

Functions

•  llGetInventoryAcquireTime Returns the time the item was added to the prim's inventory
•  llGetInventoryName Returns the inventory item's name
•  llGetInventoryType Tests to see if an inventory item exists and returns its type
•  llGetInventoryNumber Returns the number of items of a specific type in inventory
•  llGetInventoryPermMask Returns the inventory item's permissions
•  llGetInventoryKey Returns the inventory item's UUID (if full perm)

Deep Notes

Search JIRA for related Issues

Signature

function string llGetInventoryDesc( string item );