You are viewing an old version of this page. Return to the latest version.
Version of 16:26, 1 April 2009 by John
Difference between revisions of "LUA:GetHP"
John Adams (talk | contribs) (New page: = LUA Functions: GetCurrentHP(param) = Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted with. [[Devel...) |
John Adams (talk | contribs) m |
||
| Line 1: | Line 1: | ||
| − | = LUA Functions: GetCurrentHP(param) = | + | == LUA Functions: GetCurrentHP(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. | ||
| − | |||
| − | + | === Syntax === | |
| − | == Syntax == | ||
var = GetCurrentHP(param) | var = GetCurrentHP(param) | ||
| Line 12: | Line 10: | ||
| − | == Parameters == | + | === Parameters === |
| − | Required: | + | Required: ''param'' (int) |
| − | ''param'' (int) | ||
| − | |||
| − | + | ''param'' must be one of the vars in the function params. In the example above, it would be either "NPC" or "Spawn" | |
| − | |||
| − | == Usage == | + | === Usage === |
function hailed(NPC, Spawn) | function hailed(NPC, Spawn) | ||
Say(NPC, "Your current hit points are " .. GetCurrentHP(Spawn) .. "!") | Say(NPC, "Your current hit points are " .. GetCurrentHP(Spawn) .. "!") | ||
| Line 27: | Line 22: | ||
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. | ||
| + | |||
| + | |||
| + | == [[Developer:LUA_Functions | Back to LUA Functions Index]] == | ||
Revision as of 16:43, 1 April 2009
Contents
LUA Functions: GetCurrentHP(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 = GetCurrentHP(param)
Must be a reference to a player or NPC.
Parameters
Required: param (int)
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 " .. GetCurrentHP(Spawn) .. "!") end
This makes the NPC respond to the player who hails it with the players current hit points.