Difference between revisions of "GetObjectsInShape"
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 parameter) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetObjectsInShape | |name=GetObjectsInShape | ||
| Line 31: | Line 30: | ||
|param7desc=filter out dead objects if necessary | |param7desc=filter out dead objects if necessary | ||
|param7default=FALSE | |param7default=FALSE | ||
| − | |returntype=object | + | |returntype=object |
| − | |returndesc= | + | |returnarra=TRUE |
| + | |returndesc=an array of objects enclosed by the specified shape | ||
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
| Line 40: | Line 40: | ||
<!-- 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 all objects enclosed by a specific shape. | Returns all objects enclosed by a specific shape. | ||
| + | |||
Parameter Info for generic parameters fA, fB, fC: | Parameter Info for generic parameters fA, fB, fC: | ||
| − | SPHERE: fA = radius (meters) | + | *SPHERE: fA = radius (meters) |
| − | CONE: fA = angle (degrees), fB = length (meters) | + | *CONE: fA = angle (degrees), fB = length (meters) |
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Latest revision as of 22:06, 2 March 2010
return an array of objects enclosed by the specified shape
object[] GetObjectsInShape(
int nObjectTypeMask,
int nShapeId,
location lLocation,
float fA,
float fB = 0.0,
float fC = 0.0,
int bExcludeDead = FALSE
);
int nObjectTypeMask,
int nShapeId,
location lLocation,
float fA,
float fB = 0.0,
float fC = 0.0,
int bExcludeDead = FALSE
);
- Parameters:
- nObjectTypeMask
- Which objects to look for
- nShapeId
- the shape to use
- lLocation
- origin and direction for this shape
- fA
- floating point generic parameter
- fB
- optional floating point generic parameter
- fC
- optional floating point generic parameter
- bExcludeDead
- filter out dead objects if necessary
- Returns:
- an array of objects enclosed by the specified shape
- Source:
- script.ldf
Description
Returns all objects enclosed by a specific shape.
Parameter Info for generic parameters fA, fB, fC:
- SPHERE: fA = radius (meters)
- CONE: fA = angle (degrees), fB = length (meters)
