Difference between revisions of "LUA:AddThreatTransfer"

 
Line 1: Line 1:
= LUA Functions: AddThreatTransfer() =
+
{{LUAFunction
Adds a threat transfer for the given percentage
+
|Name = AddThreatTransfer
 
+
|Description = Adds a threat transfer for the given percentage
==== Syntax ====
+
|Param1 = Spawn
AddThreatTransfer(param1, param2, param3)
+
|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), ''param3'' (float)
+
|Param3Desc = is the percentage of hate to transfer
: ''param1'' is the spawn who will be transferring the hate
+
|Example =
: ''param2'' is the spawn who we transfer the hate to
 
: ''param3'' is the percentage of hate to transfer
 
 
 
 
 
==== Usage ====
 
 
<pre>
 
<pre>
 
function cast(Caster, Target)
 
function cast(Caster, Target)
Line 19: Line 14:
 
end
 
end
 
</pre>
 
</pre>
 
+
|ExampleDesc = When cast this spell will add a threat transfer of 30%
When cast this spell will add a threat transfer of 30%
+
|Notes = Only 1 threat transfer can be active at a time
 
 
== Notes ==
 
Only 1 threat transfer can be active at a time
 
  
 
This function can only be used in a spell script
 
This function can only be used in a spell script
 +
}}

Latest revision as of 12:08, 30 January 2021


LUA:AllFunctions - AddThreatTransfer

Return to: LUA:AllFunctions | Tutorials | Portal | Forum | Project Manager | Bug Tracker


Adds a threat transfer for the given percentage

Syntax

AddThreatTransfer(param1, param2, param3)

Parameters

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


Example

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

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

Notes

Only 1 threat transfer can be active at a time

This function can only be used in a spell script