Difference between revisions of "GetClusterCenter"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m (Correcting category)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Generated with errors}}
 
 
{{dafunction
 
{{dafunction
 
|name=GetClusterCenter
 
|name=GetClusterCenter
Line 14: Line 13:
 
|param4type=int
 
|param4type=int
 
|param4name=nAllyFailChance
 
|param4name=nAllyFailChance
|param4desc=A percentage chance to fail each possible cluster if any ally is inside the cluster. The chance is comulative per ally
+
|param4desc=A percentage chance to fail each possible cluster if any ally is inside the cluster. The chance is cumulative per ally
 
|param5type=int
 
|param5type=int
 
|param5name=bReturnFirstMatch
 
|param5name=bReturnFirstMatch
 
|param5desc=
 
|param5desc=
 
|returntype=location
 
|returntype=location
|returndesc=
+
|returndesc=the center of the best cluster of creatures based on input params
 
|sourcefile=script.ldf
 
|sourcefile=script.ldf
 
|sourcemodule=
 
|sourcemodule=
 
}}
 
}}
 
 
== 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 the center of the best cluster of creatures based on input params
 
Returns the center of the best cluster of creatures based on input params
 
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
 
<!-- == Examples == -->
 
<!-- == Examples == -->
 
<!-- This section contains examples transcluded from the snippet library. -->
 
<!-- This section contains examples transcluded from the snippet library. -->
 
 
<!-- == See also == -->
 
<!-- == See also == -->
 
<!-- This section contains links to articles, functions or constant groups. -->
 
<!-- This section contains links to articles, functions or constant groups. -->
  
[[Category: Effect access functions]]
+
[[Category:Effect functions]]

Latest revision as of 19:46, 10 March 2012

This function return the center of a cluster of creatures

location GetClusterCenter(
object oCreator,
int nAbilityId,
int nClusterSize,
int nAllyFailChance,
int bReturnFirstMatch
);
Parameters:
oCreator
effect creator
nAbilityId
ability id
nClusterSize
min number of enemies needed
nAllyFailChance
A percentage chance to fail each possible cluster if any ally is inside the cluster. The chance is cumulative per ally
bReturnFirstMatch
[Undocumented]
Returns:

the center of the best cluster of creatures based on input params

Source:

script.ldf

Description

Returns the center of the best cluster of creatures based on input params