Difference between revisions of "%character%.Held function"

Latest revision as of 07:47, 21 February 2013

This function returns a list of the keys of all of the objects that are in the player's, or another characters, inventory.

This function has one parameter which can be either true or false.

If this is set to true or omitted (ie. %character%.Held(true) or %character%.Held ), then this function will return a complete list of everything in the characters inventory, including objects that are inside of other objects.
If the parameter is set to false (ie. %character%.Held(false) ), then only those objects directly held by the character will be listed and anything contained inside those objects will be ignored.

This list can be filtered using any selection-only property of objects, and printed using the list function.

Use the Count function to obtain the number of objects in the characters inventory as an integer.

@@ Line 1: / Line 1: @@
 This function returns a list of the keys of all of the objects that are in the player's, or another characters, inventory.
+This function has one parameter which can be either '''true''' or '''false'''.
+* If this is set to '''true''' or omitted (ie. '''%character%.Held(true)''' or '''%character%.Held''' ), then this function will return a complete list of everything in the characters inventory, including objects that are inside of other objects.
+* If the parameter is set to '''false''' (ie. '''%character%.Held(false)''' ), then only those objects directly held by the character will be listed and anything contained inside those objects will be ignored.
 This list can be filtered using any selection-only property of objects, and printed using the [[List_Functions#List|list]] function.