Difference between revisions of "GetObjectsInArea"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
BryanDerksen (Talk | contribs) (fill in missing fields) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetObjectsInArea | |name=GetObjectsInArea | ||
| − | |brief= | + | |brief=Returns an array with all objects in an area. |
|param1type=object | |param1type=object | ||
|param1name=oArea | |param1name=oArea | ||
| Line 11: | Line 10: | ||
|param2desc=If specified, only objects will this tag will be returned | |param2desc=If specified, only objects will this tag will be returned | ||
|param2default="" | |param2default="" | ||
| − | |returntype=object | + | |returntype=object |
| − | |returndesc= | + | |returnarra=TRUE |
| + | |returndesc=an array with all objects in an area | ||
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
| Line 19: | Line 19: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | Returns an array with all objects in an area. You can also specify | + | Returns an array with all objects in an area. You can also specify a tag so the array only has all objects with that tag in that area. Check the size afterwards with GetArraySize. |
| − | a tag so the array only has all objects with that tag in that area. | + | |
| − | Check the size afterwards with GetArraySize. | + | |
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Latest revision as of 21:07, 2 March 2010
Returns an array with all objects in an area.
- Parameters:
- oArea
- an area object
- sTag
- If specified, only objects will this tag will be returned
- Returns:
- an array with all objects in an area
- Source:
- script.ldf
Description
Returns an array with all objects in an area. You can also specify a tag so the array only has all objects with that tag in that area. Check the size afterwards with GetArraySize.
