Difference between revisions of "LUA:CompareSpawns"

(Created page with "= LUA Functions: AddHate() = Adds hate to ''param2'' from ''param1'' ==== Syntax ==== AddHate(param1, param2, param3) ==== Parameters ==== ; Required - ''param1'' (Spawn), ''...")
 
 
Line 1: Line 1:
= LUA Functions: AddHate() =
+
= LUA Functions: CompareSpawns() =
Adds hate to ''param2'' from ''param1''
+
Compares the given spawns
  
  
 
==== Syntax ====
 
==== Syntax ====
AddHate(param1, param2, param3)
+
CompareSpawns(param1, param2)
  
  
 
==== Parameters ====
 
==== Parameters ====
; Required - ''param1'' (Spawn), ''param2'' (Spawn), ''param3'' (sint32)
+
; Required - ''param1'' (Spawn), ''param2'' (Spawn)
: ''param1'' is the spawn that is adding hate
+
: ''param1'' is the first spawn to compare
: ''param2'' is the spawn recieving the hate
+
: ''param2'' is the second spawn to compare
: ''param3'' is the amount of hate to add
 
  
 
==== Usage ====
 
==== Usage ====
 
<pre>
 
<pre>
function cast(Caster, Target)
+
function hailed(NPC, Spawn)
     -- Add 50 hate to the target
+
     local target = GetTarget(NPC)
     AddHate(Caster, Target, 50)
+
     if target ~= nil and CompareSpawns(target, Spawn) then
 +
        Say(NPC, "I have you targeted")
 +
    end
 
end
 
end
 
</pre>
 
</pre>
  
This is a simple taunt spell that adds 50 hate to the target.
+
This will have the spawn say whether the player who hailed it is also its target
  
 
== Notes ==
 
== Notes ==
If this is called from a spell script then the target/targets will be determined by the spell data(encounter AE, true AE, single target, etc...), the param is still required though.
+
Returns a bool, true if the spawns are the same.

Latest revision as of 17:32, 28 August 2013

LUA Functions: CompareSpawns()

Compares the given spawns


Syntax

CompareSpawns(param1, param2)


Parameters

Required - param1 (Spawn), param2 (Spawn)
param1 is the first spawn to compare
param2 is the second spawn to compare

Usage

function hailed(NPC, Spawn)
    local target = GetTarget(NPC)
    if target ~= nil and CompareSpawns(target, Spawn) then
        Say(NPC, "I have you targeted")
    end
end

This will have the spawn say whether the player who hailed it is also its target

Notes

Returns a bool, true if the spawns are the same.