Difference between revisions of "GetTurnResistanceHD"

From NWN Lexicon
Jump to: navigation, search
 
Line 1: Line 1:
=GetTurnResistanceHD(object)=
+
{{DISPLAYTITLE:GetTurnResistanceHD(object)}}__NOTOC__
 
+
Determines the number of HitDice of Turn Resistance the creature has.
Determines the number of HitDice of Turn Resistance the undead creature has.
 
 
 
 
<nwscript>
 
<nwscript>
 
int GetTurnResistanceHD(
 
int GetTurnResistanceHD(
Line 11: Line 9:
 
====Parameters====
 
====Parameters====
  
''oUndead''
+
;oUndead
 
+
:Creature to run check on. (Default: OBJECT_SELF)
undead creature to run check on. (Default: OBJECT_SELF)
 
 
 
<br />
 
  
 
====Description====
 
====Description====
  
Get the number of Hitdice worth of Turn Resistance that oUndead may have. This will only work on undead creatures.
+
Get the number of Hitdice worth of Turn Resistance that oUndead may have.
  
<br /><br />
+
While it specifies oUndead and references not working on players/non-undead, it in fact does work on any creature.
  
 
====Remarks====
 
====Remarks====
  
Works on non-undead creatures.
+
This checks for [[EffectTurnResistanceIncrease]], [[EffectTurnResistanceDecrease]] and appropriate item properties.
 
 
Doesn't work on player characters (except possesed DM/familiar).
 
  
 +
It is used primarily in the Turn Undead spell script nw_s2_turndead.nss
  
 
====Version====
 
====Version====

Latest revision as of 12:11, 3 November 2020

Determines the number of HitDice of Turn Resistance the creature has.

int GetTurnResistanceHD(
    object oUndead = OBJECT_SELF
);

Parameters

oUndead
Creature to run check on. (Default: OBJECT_SELF)

Description

Get the number of Hitdice worth of Turn Resistance that oUndead may have.

While it specifies oUndead and references not working on players/non-undead, it in fact does work on any creature.

Remarks

This checks for EffectTurnResistanceIncrease, EffectTurnResistanceDecrease and appropriate item properties.

It is used primarily in the Turn Undead spell script nw_s2_turndead.nss

Version

1.22

See Also

functions: 

GetEnemyHD



 author: Jody Fletcher