Difference between revisions of "LUA:GetAgi"

(Usage)
m (Reverted edits by Iheqidela (talk) to last revision by John)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= LUA Functions: GetAgi =
+
== 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
+
var = GetAgi(param)
  
  
== Parameters ==
+
=== Parameters ===
Required: ''param'' must be a reference to a player or NPC.
+
Required: ''param'' (int)
  
  
== Usage ==
+
=== Notes ===
 +
''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)
 
   function hailed(NPC, Spawn)
 
     Say(NPC, "Your agility is " .. GetAgi(Spawn) .. "! Very impressive!")
 
     Say(NPC, "Your agility is " .. GetAgi(Spawn) .. "! Very impressive!")
 
   end
 
   end
  
== Notes ==
+
This makes the NPC respond to the player who hails it with the players agility.
(optional)
 

Latest revision as of 18:55, 23 November 2010

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)


Parameters

Required: param (int)


Notes

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