Difference between revisions of "GetObjectsInShape"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m (1 revision: re-import with default parameter value parameters set)
Line 6: Line 6:
 
|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
 +
|param7default=FALSE
 
|returntype=object[]
 
|returntype=object[]
 
|returndesc=
 
|returndesc=

Revision as of 23:28, 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.

return an array of objects enclosed by the specified shape

[[object[] keyword|object[]]] GetObjectsInShape(
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:

[Undocumented]

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)