LUA:CommandTemplate - Revision history

John adams at 23:36, 12 February 2012

2012-02-12T23:36:29Z

John adams at 23:33, 12 February 2012

2012-02-12T23:33:58Z

John adams: Created page with "= EQ2Emulator: LUA Command Template = Use the template below when building the LUA:{command} Wiki pages. Keep things consistent!

 = LUA Functions: GetCurrentHP() = Returns ..."

2012-02-12T23:32:59Z

Created page with "= EQ2Emulator: LUA Command Template = Use the template below when building the LUA:{command} Wiki pages. Keep things consistent! <pre> = LUA Functions: GetCurrentHP() = Returns ..."

New page

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

<pre>
= 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
</pre>

'''Note:''' Replace {Type} with the parent page that this item belongs to (eg., LUA:GetFunctions if the command is a LUA "Get")
<nowiki>[[LUA:{Type}|Back to LUA {Type} Index]]</nowiki>

[[Main_Page|Back to Main Page]]

← Older revision		Revision as of 23:36, 12 February 2012
Line 47:		Line 47:


−	[[~~Main_Page~~\|Back to ~~Main Page~~]]	+	[[LUA\|Back to LUA]]

@@ Line 2: / Line 2: @@
 Use the template below when building the LUA:{command} Wiki pages. Keep things consistent!
 <pre>
 = LUA Functions: GetCurrentHP() =
@@ Line 37: / Line 39: @@
 </pre>
 '''Note:''' Replace {Type} with the parent page that this item belongs to (eg., LUA:GetFunctions if the command is a LUA "Get")