LUA:AddSpellTimer - Revision history

Cynnar at 19:09, 30 January 2021

2021-01-30T19:09:30Z

Jabantiz at 21:34, 9 March 2014

2014-03-09T21:34:38Z

Jabantiz at 21:59, 16 January 2014

2014-01-16T21:59:20Z

Jabantiz: Created page with "= LUA Functions: IsFlanking() = Checks to see if the given spawn is flanking the target spawn ==== Syntax ==== IsFlanking(param1, param2) ==== Parameters ==== ; Required - ''p..."

2014-01-16T21:48:14Z

Created page with "= LUA Functions: IsFlanking() = Checks to see if the given spawn is flanking the target spawn ==== Syntax ==== IsFlanking(param1, param2) ==== Parameters ==== ; Required - ''p..."

New page

= LUA Functions: IsFlanking() =
Checks to see if the given spawn is flanking the target spawn

==== Syntax ====
IsFlanking(param1, param2)

==== Parameters ====
; Required - ''param1'' (Spawn), ''param2'' (Spawn)
: ''param1'' is the spawn who will be checking the other
: ''param2'' is the spawn we want to know if it is flanking

==== Usage ====
<pre>
function precast(Caster, Target)
return IsFlanking(Target, Caster)
end
</pre>

Will check to see if the caster is flanking the target before casting

@@ Line 1: / Line 1: @@
-= LUA Functions: AddSpellTimer() =
+{{LUAFunction
-Adds a timer to the spell that will call the given function
+|Name = AddSpellTimer
+|Description = Adds a timer to the spell that will call the given function
-==== Syntax ====
+|Param1 = int32
-AddSpellTimer(param1, param2, [param3], [param4])
+|Param1Desc = is the time in milliseconds
+|Param2 = String
+|Param2Desc = is the function to call when the time is up
-==== Parameters ====
+|OptionalParam1 = Spawn
-; Required - ''param1'' (int32), ''param2'' (string)
+|OptionalParam1Desc = is the spawn to pass as the caster to the callback function
-: ''param1'' is the time in milliseconds
+|OptionalParam2 = Spawn
-: ''param2'' is the function to call when the time is up
+OptionalParam2Desc = is the spawn to pass as the target to the callback function
-; Optional - ''param3'' (Spawn), ''param4'' (Spawn)
+|Example =
 <pre>
 function proc(Caster, Target, Type)
@@ Line 26: / Line 21: @@
 end
 </pre>
+|ExampleDesc = This spell will stun the target on a proc and remove the stun after 1 second
-This spell will stun the target on a proc and remove the stun after 1 second
+|Notes = If optional param1 and optional param2 are not given it will use the same caster and target used in the cast/tick/remove functions
+}}

@@ Line 8: / Line 8: @@
 ==== Parameters ====
 ; Required - ''param1'' (int32), ''param2'' (string)
-: ''param1'' is the spawn who will be checking the other
+: ''param1'' is the time in milliseconds
-: ''param2'' is the spawn we want to know if it is flanking
+: ''param2'' is the function to call when the time is up
 ; Optional - ''param3'' (Spawn), ''param4'' (Spawn)
 : ''param3'' is the spawn to pass as the caster to the callback function