Difference between revisions of "RemoveItemsByTag"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(add default, fix missing parameter description)
(Generated by Sunjammer's Dragon Age Script Paser)
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{Generated with errors}}
 
{{dafunction
 
{{dafunction
 
|name=RemoveItemsByTag
 
|name=RemoveItemsByTag
Line 5: Line 6:
 
|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=
 +
|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=

Revision as of 23:37, 31 July 2009

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was unable to extract and/or match all the information required and has flagged this page as containing one or more errors. The source file was not formatted correctly and the information presented is incomplete or incorrect.

This page must be reviewed by a knowledgeable scripter as it will need to be updated. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with errors}} tag once the page has been corrected.

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
[Undocumented]
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.