Difference between revisions of "LUA:GetEncounterSize"

(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: GetEncounterSize() =
Adds hate to ''param2'' from ''param1''
+
Gets the number of spawns in the encounter for the given spawn
  
  
 
==== Syntax ====
 
==== Syntax ====
AddHate(param1, param2, param3)
+
GetEncounterSize(param1)
  
  
 
==== Parameters ====
 
==== Parameters ====
; Required - ''param1'' (Spawn), ''param2'' (Spawn), ''param3'' (sint32)
+
; Required - ''param1'' (Spawn)
: ''param1'' is the spawn that is adding hate
+
: ''param1'' is the spawn who's encounter we want to check
: ''param2'' is the spawn recieving the hate
 
: ''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
+
     Say(NPC, "There are " .. GetEncounterSize(NPC) .. " in my encounter list")
    AddHate(Caster, Target, 50)
 
 
end
 
end
 
</pre>
 
</pre>
  
This is a simple taunt spell that adds 50 hate to the target.
+
This will make the hailed spawn respond with how many spawns are in its encounter list
  
 
== 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.
+
An encounter is a list of every one who will get credit for killing the spawn

Latest revision as of 20:46, 28 August 2013

LUA Functions: GetEncounterSize()

Gets the number of spawns in the encounter for the given spawn


Syntax

GetEncounterSize(param1)


Parameters

Required - param1 (Spawn)
param1 is the spawn who's encounter we want to check

Usage

function hailed(NPC, Spawn)
    Say(NPC, "There are " .. GetEncounterSize(NPC) .. " in my encounter list")
end

This will make the hailed spawn respond with how many spawns are in its encounter list

Notes

An encounter is a list of every one who will get credit for killing the spawn