Difference between revisions of "GetCombatantType"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (links) |
BryanDerksen (Talk | contribs) (noting the inconsistency Sunjammer found in this function's return type) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
|name=GetCombatantType | |name=GetCombatantType | ||
| − | |brief=Returns the | + | |brief=Returns the Combatant Type of a creature |
|param1type=object | |param1type=object | ||
|param1name=oidCreature | |param1name=oidCreature | ||
|param1desc=The creature | |param1desc=The creature | ||
|returntype=int | |returntype=int | ||
| − | |returndesc= | + | |returndesc=a CREATURE_TYPE_COMBATANT or CREATURE_TYPE_NON_COMBATANT constant |
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
| Line 13: | Line 13: | ||
== 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 a CREATURE_TYPE_COMBATANT or CREATURE_TYPE_NON_COMBATANT constant. | ||
| + | |||
| + | Note that 2da_constants_h also defines a set of CREATURE_TYPE constants. These are not returned by this function, only the CREATURE_TYPE constants defined in script.ldf apply here. | ||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Revision as of 20:47, 19 February 2010
Returns the Combatant Type of a creature
- Parameters:
- oidCreature
- The creature
- Returns:
- a CREATURE_TYPE_COMBATANT or CREATURE_TYPE_NON_COMBATANT constant
- Source:
- script.ldf
Description
Returns a CREATURE_TYPE_COMBATANT or CREATURE_TYPE_NON_COMBATANT constant.
Note that 2da_constants_h also defines a set of CREATURE_TYPE constants. These are not returned by this function, only the CREATURE_TYPE constants defined in script.ldf apply here.
