Difference between revisions of "LUA:GetAgi"

Line 1: Line 1:
 +
== LUA Functions: GetAgi(param) ==
 +
 
Returns the current '''agility''' of ''param''. The parameter can be either a player or the NPC currently being interacted with.
 
Returns the current '''agility''' of ''param''. The parameter can be either a player or the NPC currently being interacted with.
  
[[Developer:LUA_Functions | Back to LUA]]
+
[[Developer:LUA_Functions | Back to LUA Functions Index]]
  
  
== Syntax ==
+
=== Syntax ===
 
var = GetAgi(param)  
 
var = GetAgi(param)  
  
Line 10: Line 12:
  
  
== Parameters ==
+
=== Parameters ===
Required:  
+
Required: ''param'' (int)
''param'' (int) usually "NPC" or "Spawn"
+
 
 +
''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 agility is " .. GetAgi(Spawn) .. "! Very impressive!")
 
     Say(NPC, "Your agility is " .. GetAgi(Spawn) .. "! Very impressive!")

Revision as of 16:52, 1 April 2009

LUA Functions: GetAgi(param)

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

Back to LUA Functions Index


Syntax

var = GetAgi(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 agility is " .. GetAgi(Spawn) .. "! Very impressive!")
 end

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