Difference between revisions of "GetObjectsInShape"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) (fill in missing parameter) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=GetObjectsInShape | |name=GetObjectsInShape | ||
Line 6: | Line 5: | ||
|param1name=nObjectTypeMask | |param1name=nObjectTypeMask | ||
|param1desc=Which objects to look for | |param1desc=Which objects to look for | ||
+ | |param1default= | ||
|param2type=int | |param2type=int | ||
|param2name=nShapeId | |param2name=nShapeId | ||
|param2desc=the shape to use | |param2desc=the shape to use | ||
+ | |param2default= | ||
|param3type=location | |param3type=location | ||
|param3name=lLocation | |param3name=lLocation | ||
|param3desc=origin and direction for this shape | |param3desc=origin and direction for this shape | ||
+ | |param3default= | ||
|param4type=float | |param4type=float | ||
|param4name=fA | |param4name=fA | ||
|param4desc=floating point generic parameter | |param4desc=floating point generic parameter | ||
+ | |param4default= | ||
|param5type=float | |param5type=float | ||
|param5name=fB | |param5name=fB | ||
|param5desc=optional floating point generic parameter | |param5desc=optional floating point generic parameter | ||
+ | |param5default=0.0 | ||
|param6type=float | |param6type=float | ||
|param6name=fC | |param6name=fC | ||
|param6desc=optional floating point generic parameter | |param6desc=optional floating point generic parameter | ||
+ | |param6default=0.0 | ||
|param7type=int | |param7type=int | ||
|param7name=bExcludeDead | |param7name=bExcludeDead | ||
|param7desc=filter out dead objects if necessary | |param7desc=filter out dead objects if necessary | ||
− | |returntype=object | + | |param7default=FALSE |
− | |returndesc= | + | |returntype=object |
+ | |returnarra=TRUE | ||
+ | |returndesc=an array of objects enclosed by the specified shape | ||
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
Line 33: | 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)