Item Search Forms and Parameters
From ISMods Wiki
Contents |
[edit]
ISXEQ2 information for Item Search Forms and Parameters has moved
[edit]
Please see: http://eq2.isxgames.com/wiki for up-to-date content.
[edit]
Description
Retrieves an item object from the game world.
[edit]
Forms
[edit]
Parameters
Parameters that work with both Inventory and Equipment arrays:
- ID,#
- Returns the item which matches the ID (#) given
- NotID,#
- Returns the first item in the array which does not match the ID (#) given
- Index,#
- Returns the item which matches the Index (#) given. "Index" is the item's location within the Inventory array beginning with 1.
- NotIndex,#
- Returns the first item in the array which does not match the Index (#) given
- container
- Returns the first container in the array
- ExactName,<string>
- Returns an item with the exact name given
- <string>
- Returns an item with a name that contains the string given (case insensitive)
Parameters that work for only the Equipment Array:
- <slotname>
- Slotname can be any of the following (24 total):
- Primary - Secondary - Head - Chest - Shoulders - Forearms - Hands - Legs - Feet - LRing - RRing - Ear2 - Ear - Neck - LWrist - RWrist - Ranged - Ammo - Waist - Cloak - Activate1 - Activate2 - Food - Drink
- <Slot#>
- Slot# can be any number between 1 and 24 and corresponds directly to the slot names listed above.
[edit]
Examples
- ${Me.Equipment[dirk].Index}
- ${Me.Equipment[container,"pristine boiled"].Name}
- ${Me.Equipment[Head].Name}
- ${Me.Equipment[15].Name}
- ${Me.Inventory[NotID,32532345,Insignia Ring]}
(Please note that commas must seperate all arguments.)
[edit]
Notes
- Use of the 'Index' search form will allow you to iterate through the Equipment array if you need to do so. Simply use the 'Index' member of the item datatype and begin with '1' and end with '22'.
[edit]
