Difference between revisions of "GetCreaturesInMeleeRing"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
||
(One intermediate revision by the same user not shown) | |||
Line 6: | Line 6: | ||
|param1name=nRingOwnerId | |param1name=nRingOwnerId | ||
|param1desc=id of the creature for which to query the melee ring | |param1desc=id of the creature for which to query the melee ring | ||
+ | |param1default= | ||
|param2type=float | |param2type=float | ||
|param2name=fStartAngle | |param2name=fStartAngle | ||
|param2desc=the angle where the search should start (supported ranges 0->360 or -180->180) | |param2desc=the angle where the search should start (supported ranges 0->360 or -180->180) | ||
+ | |param2default= | ||
|param3type=float | |param3type=float | ||
|param3name=fEndAngle | |param3name=fEndAngle | ||
|param3desc=angle where the search should stop (fEndAngle >= fStartAngle) | |param3desc=angle where the search should stop (fEndAngle >= fStartAngle) | ||
+ | |param3default= | ||
|param4type=int | |param4type=int | ||
|param4name=bOnlyHostiles | |param4name=bOnlyHostiles | ||
|param4desc=set to TRUE if the array should only contain hostile creatures | |param4desc=set to TRUE if the array should only contain hostile creatures | ||
+ | |param4default=FALSE | ||
|param5type=int | |param5type=int | ||
|param5name=nRingIndex | |param5name=nRingIndex | ||
|param5desc=the ring to query. By default the main ring will respond to the query (ring index 0) | |param5desc=the ring to query. By default the main ring will respond to the query (ring index 0) | ||
+ | |param5default=0 | ||
|returntype=object[] | |returntype=object[] | ||
|returndesc= | |returndesc= |
Latest revision as of 23:14, 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 creatures contained in the melee ring for the given angles
[[object[] keyword|object[]]] GetCreaturesInMeleeRing(
object nRingOwnerId,
float fStartAngle,
float fEndAngle,
int bOnlyHostiles = FALSE,
int nRingIndex = 0
);
object nRingOwnerId,
float fStartAngle,
float fEndAngle,
int bOnlyHostiles = FALSE,
int nRingIndex = 0
);
- Parameters:
- nRingOwnerId
- id of the creature for which to query the melee ring
- fStartAngle
- the angle where the search should start (supported ranges 0->360 or -180->180)
- fEndAngle
- angle where the search should stop (fEndAngle >= fStartAngle)
- bOnlyHostiles
- set to TRUE if the array should only contain hostile creatures
- nRingIndex
- the ring to query. By default the main ring will respond to the query (ring index 0)
- Returns:
- [Undocumented]
- Source:
- script.ldf