You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "LUA:GetDistance"
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == LUA Functions: GetDistance(param1, param2, [param3]) == | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == 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. | Returns the '''distance''' in meters of ''param1'' from ''param2''. The parameter can be either the targeted player (Spawn) or the NPC. | ||
| Line 14: | Line 6: | ||
=== Syntax === | === Syntax === | ||
| − | var = GetDistance(param1, param2) | + | var = GetDistance(param1, param2, [param3]) |
=== Parameters === | === Parameters === | ||
| − | Required | + | ; Required - ''param1'' (Spawn), ''param2'' (Spawn) |
| − | + | : ''param1'' is the source object | |
| + | : ''param2'' is the destination object | ||
| + | ; Otional - ''param3''(int8) | ||
| + | : ''param3'' include the collision radius in the calcs, 1 = yes | ||
Latest revision as of 21:18, 12 September 2013
Contents
LUA Functions: GetDistance(param1, param2, [param3])
Returns the distance in meters of param1 from param2. The parameter can be either the targeted player (Spawn) or the NPC.
Syntax
var = GetDistance(param1, param2, [param3])
Parameters
- Required - param1 (Spawn), param2 (Spawn)
- param1 is the source object
- param2 is the destination object
- Otional - param3(int8)
- param3 include the collision radius in the calcs, 1 = yes
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.