You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "Page Design Test 1"
(Blanked the page) |
|||
| (48 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{PageHeaderChild|Admins|Content - Quest}} | ||
| + | <br/> | ||
| + | = 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 | ||
Latest revision as of 21:28, 23 January 2017
Admins - Content - Quest
Return to: Admins | Tutorials | Portal | Forum | Project Manager | Bug Tracker
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.
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