Difference between revisions of "LUA:GetAgi"

m (Reverted edits by Iheqidela (talk) to last revision by John)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== LUA Functions: GetAgi(param) ==
 
== 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.
  
Line 8: Line 7:
 
=== Syntax ===
 
=== Syntax ===
 
var = GetAgi(param)  
 
var = GetAgi(param)  
 
Must be a reference to a player or NPC.
 
  
  
Line 15: Line 12:
 
Required: ''param'' (int)
 
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"
 
''param'' must be one of the vars in the function params. In the example above, it would be either "NPC" or "Spawn"
  
Line 23: Line 22:
 
   end
 
   end
  
This makes the NPC respond to the player who hails it with the players current agility.
+
This makes the NPC respond to the player who hails it with the players agility.

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.