No categories assigned

LUA:GetDistance

Revision as of 17:17, 1 April 2009 by John Adams (talk | contribs) (New page: == LUA Functions: GetDistance(param1, param2) == Returns the '''distance''' in meters of ''param1'' from ''param2''. The parameter can be either the targeted player (Spawn) or the NPC. [[...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

LUA Functions: GetDistance(param1, param2)

Returns the distance in meters of param1 from param2. The parameter can be either the targeted player (Spawn) or the NPC.

Back to LUA Functions Index


Syntax

var = GetDistance(param1, param2)


Parameters

Required: param1 (int) is the source object Required: param2 (int) is the destination object


Notes

param1 and param2 must be one of the vars in the function params. In the example below, it would be either "NPC" or "Spawn"


Usage

 function hailed(NPC, Spawn)
   Say(NPC, "The distance between you and I is " .. GetDistance(NPC, Spawn) .. " meters.")
 end

This makes the NPC respond to the player who hails it with the distance the player is from the NPC in meters.