OsGetInventoryNames
From OpenSimulator
(Difference between revisions)
JeffKelley (Talk | contribs) (Created page with "{{osslfunc |threat_level=ignored |permissions=true |delay=0|function_syntax=osGetInventoryNames(integer type)<br> |ossl_example=<source lang="lsl"> </source> |description= Ret...") |
JeffKelley (Talk | contribs) m (Note about order) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
|threat_level=ignored | |threat_level=ignored | ||
|permissions=true | |permissions=true | ||
| − | |delay=0|function_syntax=osGetInventoryNames(integer type)<br> | + | |delay=0|function_syntax=list osGetInventoryNames(integer type)<br> |
|ossl_example=<source lang="lsl"> | |ossl_example=<source lang="lsl"> | ||
| + | // Example for osGetInventoryNames | ||
| + | // This script uses the function osGetInventoryNames to return a list of inventory items by name | ||
| + | // based on the inventory type (INVENTORY_ALL) | ||
| + | // The found item names are output to owner chat | ||
| + | |||
| + | // Define the inventory type constant | ||
| + | integer INVENTORY_TYPE = INVENTORY_ALL; | ||
| + | |||
| + | // Event handler, that is executed on script start | ||
| + | default | ||
| + | { | ||
| + | state_entry() | ||
| + | { | ||
| + | // Use osGetInventoryNames to fetch the list of inventory items by name | ||
| + | list inventoryList = osGetInventoryNames(INVENTORY_TYPE); | ||
| + | |||
| + | // Check if the list is empty | ||
| + | if (llGetListLength(inventoryList) > 0) | ||
| + | { | ||
| + | // Go through the list and output each item to chat | ||
| + | integer numItems = llGetListLength(inventoryList); | ||
| + | string itemNames = "Inventory item(s):\n"; | ||
| + | integer i; | ||
| + | for (i = 0; i < numItems; ++i) | ||
| + | { | ||
| + | string itemName = llList2String(inventoryList, i); | ||
| + | itemNames += itemName + "\n"; | ||
| + | } | ||
| + | llOwnerSay(itemNames); | ||
| + | } | ||
| + | else | ||
| + | { | ||
| + | // If the list is empty give indication as such | ||
| + | llOwnerSay("Inventory is empty."); | ||
| + | } | ||
| + | } | ||
| + | } | ||
</source> | </source> | ||
|description= | |description= | ||
Return a list of items names by type (or INVENTORY_ALL) located in the prim inventory. | Return a list of items names by type (or INVENTORY_ALL) located in the prim inventory. | ||
| + | List ordering is arbitrary. Successive calls may return different orders. | ||
|additional_info=This function was added in 0.9.3.0 | |additional_info=This function was added in 0.9.3.0 | ||
}} | }} | ||
Latest revision as of 03:56, 29 March 2024
list osGetInventoryNames(integer type)
| |
| Return a list of items names by type (or INVENTORY_ALL) located in the prim inventory.
List ordering is arbitrary. Successive calls may return different orders. | |
| Threat Level | This function does not do a threat level check |
| Permissions | Use of this function is always allowed by default |
| Extra Delay | 0 seconds |
| Example(s) | |
// Example for osGetInventoryNames // This script uses the function osGetInventoryNames to return a list of inventory items by name // based on the inventory type (INVENTORY_ALL) // The found item names are output to owner chat // Define the inventory type constant integer INVENTORY_TYPE = INVENTORY_ALL; // Event handler, that is executed on script start default { state_entry() { // Use osGetInventoryNames to fetch the list of inventory items by name list inventoryList = osGetInventoryNames(INVENTORY_TYPE); // Check if the list is empty if (llGetListLength(inventoryList) > 0) { // Go through the list and output each item to chat integer numItems = llGetListLength(inventoryList); string itemNames = "Inventory item(s):\n"; integer i; for (i = 0; i < numItems; ++i) { string itemName = llList2String(inventoryList, i); itemNames += itemName + "\n"; } llOwnerSay(itemNames); } else { // If the list is empty give indication as such llOwnerSay("Inventory is empty."); } } } | |
| Notes | |
| This function was added in 0.9.3.0 | |