Difference between revisions of "RemoveItemsByTag"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(add default, fix missing parameter description)
m (param2 desc)
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
|param1name=oPossessor
 
|param1name=oPossessor
 
|param1desc=The placeable or creature to remove items from
 
|param1desc=The placeable or creature to remove items from
 +
|param1default=
 
|param2type=string
 
|param2type=string
 
|param2name=sTag
 
|param2name=sTag
 
|param2desc=The tag of the item to be removed
 
|param2desc=The tag of the item to be removed
 +
|param2default=
 
|param3type=int
 
|param3type=int
 
|param3name=nNumItems
 
|param3name=nNumItems
 
|param3desc=The number of items to be removed. Use -1 to remove all matching items
 
|param3desc=The number of items to be removed. Use -1 to remove all matching items
|param3default= -1
+
|param3default=-1
 
|returntype=void
 
|returntype=void
 
|returndesc=
 
|returndesc=

Latest revision as of 23:34, 31 July 2009

Removes item(s) from its container

void RemoveItemsByTag(
object oPossessor,
string sTag,
int nNumItems = -1
);
Parameters:
oPossessor
The placeable or creature to remove items from
sTag
The tag of the item to be removed
nNumItems
The number of items to be removed. Use -1 to remove all matching items
Returns:

Nothing.

Source:

script.ldf

Description

Removes the matching item(s) from its container/inventory.