You are viewing an old version of this page. Return to the latest version.

Difference between revisions of "LUA:AddThreatTransfer"

Latest revision as of 12:08, 30 January 2021

LUA:AllFunctions - AddThreatTransfer

Adds a threat transfer for the given percentage

AddThreatTransfer(param1, param2, param3)

Required - param1 (Spawn), param2 (spawn), param3 (float): param1 is the spawn who will be transferring the hate; param2 is the spawn who we transfer the hate to; param3 is the percentage of hate to transfer

function cast(Caster, Target)
    AddThreatTransfer(Caster, Target, 30)
end

When cast this spell will add a threat transfer of 30%

Only 1 threat transfer can be active at a time

This function can only be used in a spell script

@@ Line 1: / Line 1: @@
-= LUA Functions: IsFlanking() =
+{{LUAFunction
-Checks to see if the given spawn is flanking the target spawn
+|Name = AddThreatTransfer
+|Description = Adds a threat transfer for the given percentage
-==== Syntax ====
+|Param1 = Spawn
-IsFlanking(param1, param2)
+|Param1Desc = is the spawn who will be transferring the hate
+|Param2 = spawn
+|Param2Desc = is the spawn who we transfer the hate to
-==== Parameters ====
+|Param3 = float
-; Required - ''param1'' (Spawn), ''param2'' (Spawn)
+|Param3Desc = is the percentage of hate to transfer
-: ''param1'' is the spawn who will be checking the other
+|Example =
-: ''param2'' is the spawn we want to know if it is flanking
-==== Usage ====
 <pre>
-function precast(Caster, Target)
+function cast(Caster, Target)
-     return IsFlanking(Target, Caster)
+     AddThreatTransfer(Caster, Target, 30)
 end
 </pre>
+|ExampleDesc = When cast this spell will add a threat transfer of 30%
+|Notes = Only 1 threat transfer can be active at a time
-Will check to see if the caster is flanking the target before casting
+This function can only be used in a spell script
+}}