LUA:CommandTemplate

EQ2Emulator: LUA Command Template

Use the template below when building the LUA:{command} Wiki pages. Keep things consistent!

Copy this block and Paste it into your new Wiki page:

= LUA Functions: GetCurrentHP() =
Returns the current '''current hit points''' of ''param''. The parameter can be either a player or the NPC currently being interacted with.

[[LUA:GetFunctions|Back to LUA GetFunctions Index]]


==== 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.


== Notes ==
(optional) Additional notes or special instructions


== Reference ==
(optional) Links to forum posts or other reference pertaining to this function

---

Note: Replace {Type} with the parent page that this item belongs to (eg., LUA:GetFunctions if the command is a LUA "Get")

[[LUA:{Type}|Back to LUA {Type} Index]]

Back to Main Page