Difference between revisions of "LUA:GetHP"

 
Line 1: Line 1:
== LUA Functions: GetCurrentHP(param) ==
+
== LUA Functions: GetHP(param) ==
 
Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted with.
 
Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted with.
  
[[Developer:LUA_Functions | Back to LUA Functions Index]]
 
  
  
 
=== Syntax ===
 
=== Syntax ===
var = GetCurrentHP(param)  
+
var = GetHP(param)  
  
  
Line 19: Line 18:
 
=== Usage ===
 
=== Usage ===
 
   function hailed(NPC, Spawn)
 
   function hailed(NPC, Spawn)
     Say(NPC, "Your current hit points are " .. GetCurrentHP(Spawn) .. "! Very impressive!")
+
     Say(NPC, "Your current hit points are " .. GetHP(Spawn) .. "! Very impressive!")
 
   end
 
   end
  
 
This makes the NPC respond to the player who hails it with the players current hit points.
 
This makes the NPC respond to the player who hails it with the players current hit points.

Latest revision as of 16:19, 17 October 2012

LUA Functions: GetHP(param)

Returns the current current hit points of param. The parameter can be either a player or the NPC currently being interacted with.


Syntax

var = GetHP(param)


Parameters

Required: param (int)


Notes

param must be one of the vars in the function params. In the example above, it would be either "NPC" or "Spawn"


Usage

 function hailed(NPC, Spawn)
   Say(NPC, "Your current hit points are " .. GetHP(Spawn) .. "! Very impressive!")
 end

This makes the NPC respond to the player who hails it with the players current hit points.