GetItemsInInventory - Revision history

Sunjammer: Fixing error with extraction

2014-06-08T09:55:34Z

Fixing error with extraction

Phaenan: Added a bug related to the nBaseItemType param

2010-08-01T21:53:39Z

Added a bug related to the nBaseItemType param

BryanDerksen at 21:02, 2 March 2010

2010-03-02T21:02:54Z

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-31T22:37:17Z

Generated by Sunjammer's Dragon Age Script Paser

BryanDerksen: 1 revision: re-import with default parameter value parameters set

2009-07-31T22:14:51Z

1 revision: re-import with default parameter value parameters set

BryanDerksen: 1 revision: Importing auto-generated function articles

2009-07-29T15:50:44Z

1 revision: Importing auto-generated function articles

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-29T01:40:43Z

Generated by Sunjammer's Dragon Age Script Paser

New page

{{Generated with errors}}
{{dafunction
|name=GetItemsInInventory
|brief=Gets all items in an object inventory
|param1type=object
|param1name=oObject
|param1desc=A creature or placeable with an inventory
|param2type=int
|param2name=nGetItemsOptions
|param2desc=
|param3type=int
|param3name=nBaseItemType
|param3desc=Return only items with base item type matching. 0 to disable this filter
|param4type=string
|param4name=sTagFilter
|param4desc=
|param5type=int
|param5name=bIgnorePlotItems
|param5desc=
|returntype=object[]
|returndesc=
|sourcefile=script.ldf
|sourcemodule=
}}

== Description ==

Provides access to a creatures or placeables inventory and equipped items.










[[Category: Items functions]]

@@ Line 1: / Line 1: @@
 {{dafunction
-|name=GetItemsInInventory
+|name          = GetItemsInInventory
-|brief=Gets all items in an object inventory
+|brief         = Gets all items in an object inventory
-|param1type=object
+|param1type    = object
-|param1name=oObject
+|param1name    = oObject
-|param1desc=A creature or placeable with an inventory
+|param1desc    = A creature or placeable with an inventory
-|param1default=
+|param1default =
-|param2type=int
+|param2type    = int
-|param2name=nGetItemsOptions
+|param2name    = nGetItemsOptions
-|param2desc=
+|param2desc    = A [[GET_ITEMS_OPTION_*]] constant
-|param2default=GET_ITEMS_OPTION_ALL
+|param2default = GET_ITEMS_OPTION_ALL
-|param3type=int
+|param3type    = int
-|param3name=nBaseItemType
+|param3name    = nBaseItemType
-|param3desc=Return only items with base item type matching. 0 to disable this filter. NB : This filter does not work on placeables inventories.
+|param3desc    = Only return items with a matching base item type or 0 to disable this filter
-|param3default=0
+|param3default = 0
-|param4type=string
+|param4type    = string
-|param4name=sTagFilter
+|param4name    = sTagFilter
-|param4desc=
+|param4desc    = Only return items with a matching tag or "" to disable this filter
-|param4default=""
+|param4default = ""
-|param5type=int
+|param5type    = int
-|param5name=bIgnorePlotItems
+|param5name    = bIgnorePlotItems
-|param5desc=
+|param5desc    = Only return items which are NOT plot items or FALSE to disable this filter
-|param5default=FALSE
+|param5default = FALSE
-|returntype=object
+|returntype    = object
-|returnarra=TRUE
+|returnarra    = TRUE
-|returndesc=
+|returndesc    = An array of all items in/on the object that match the specified filters
-|sourcefile=script.ldf
+|sourcefile    = script.ldf
-|sourcemodule=
+|sourcemodul   =
 }}
 == Description ==
 <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
-Provides access to a creatures or placeables inventory and equipped items.
+Provides access to a [[creature|creature's]] or [[placeable|placeable's]] inventory and equipped items.
-<!-- == Remarks == -->
+== Remarks ==
 <!-- This section contains additional comments, observations and known issues. -->
-<!-- == Examples == -->
+The <code>nBaseItemType</code> filter does not work on placeable's inventories.
 <!-- This section contains examples transcluded from the snippet library. -->
 <!-- == See also == -->
 <!-- This section contains links to articles, functions or constant groups. -->
-[[Category: Items functions]]
+[[Category:Items functions]]

← Older revision	Revision as of 22:14, 31 July 2009
(No difference)

← Older revision	Revision as of 15:50, 29 July 2009
(No difference)