Difference between revisions of "GetCombatantType"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (noting the inconsistency Sunjammer found in this function's return type) |
m (Updated links) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name=GetCombatantType | + | |name = GetCombatantType |
| − | |brief=Returns the Combatant Type of a creature | + | |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 = [[CREATURE_TYPE_*|CREATURE_TYPE_COMBATANT]] or [[CREATURE_TYPE_*|CREATURE_TYPE_NON_COMBATANT ]] |
| − | |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 the 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. | |
| − | + | ||
| − | Note that 2da_constants_h also defines a set of | + | |
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Latest revision as of 13:22, 3 August 2011
Returns the Combatant Type of a creature
- Parameters:
- oidCreature
- The creature
- Returns:
- CREATURE_TYPE_COMBATANT or CREATURE_TYPE_NON_COMBATANT
- Source:
- script.ldf
Description
Returns the 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.
