Difference between revisions of "LUA:AddControlEffect"

 
Line 1: Line 1:
{{PageHeaderChild|LUA|AddControlEffect}}
+
{{LUAFunction
 +
|Name = AddControlEffect
 +
|Description = Adds a control effect (mez/stun) to the given spawn.
 +
|Param1 = Spawn
 +
|Param1Desc = must be a reference to a player or NPC.
 +
|Param2 = int8
 +
|Param2Desc = must be a valid number representing a control effect to add (see below)
 +
|OptionalParam1 = int8
 +
|OptionalParam1Desc = if set to 1, only add the control effect to the first param spawn
 +
|Example =
 +
<pre>
 +
function cast(Caster, Target)
 +
  -- Mez the target.
 +
  AddControlEffect(Target, 1)
 +
end
 +
</pre>
 +
|ExampleDesc = This will mez the target.
 +
|Notes = If this is used in a spell script a small amount of hate will be added to the target, if the effect is considered hostile.
  
= LUA Functions: AddControlEffect() =
 
Adds a control effect (mez/stun) to the given spawn.
 
  
 +
=== Types ===
  
==== Syntax ====
+
1 - Mez
AddControlEffect(param1, param2, [param3])
 
  
==== Parameters ====
+
2 - Stifle
; Required - ''param1'' (Spawn), ''param2'' (int8)
 
: ''param1'' must be a reference to a player or NPC.
 
: ''param2'' must be a valid number representing a control effect to add (see below)
 
; Optional - ''param3'' (int8)
 
: ''param3'' if set to 1, only add the control effect to the first param spawn
 
  
==== Usage ====
+
3 - Daze
function cast(Caster, Target)
 
  -- Mez the target.
 
  AddControlEffect(Target, 1)
 
end
 
  
This will mez the target.
+
4 - Stun
  
 +
5 - Root
  
== Notes ==
+
6 - Fear
If this is used in a spell script a small amount of hate will be added to the target, if the effect is considered hostile.
+
 
; Types
+
7 - Waterwalking
: 1 - Mez
+
 
: 2 - Stifle
+
8 - Underwater Moonjumps
: 3 - Daze
+
 
: 4 - Stun
+
11 - Snare
: 5 - Root
+
 
: 6 - Fear
+
12 - Flight
: 7 - Waterwalking
+
 
: 8 - Underwater Moonjumps
+
13 - Glide
: 11 - Snare
+
 
: 12 - Flight
+
14 - Safefall
: 13 - Glide
+
}}
: 14 - Safefall
 

Latest revision as of 11:55, 30 January 2021


LUA:AllFunctions - AddControlEffect

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


Adds a control effect (mez/stun) to the given spawn.

Syntax

AddControlEffect(param1, param2, [opt param1])

Parameters

Required - param1 (Spawn), param2 (int8)
param1 must be a reference to a player or NPC.
param2 must be a valid number representing a control effect to add (see below)
Optional - opt param1 (int8)
opt param1 if set to 1, only add the control effect to the first param spawn

Example

function cast(Caster, Target)
  -- Mez the target.
  AddControlEffect(Target, 1)
end

This will mez the target.

Notes

If this is used in a spell script a small amount of hate will be added to the target, if the effect is considered hostile.


Types

1 - Mez

2 - Stifle

3 - Daze

4 - Stun

5 - Root

6 - Fear

7 - Waterwalking

8 - Underwater Moonjumps

11 - Snare

12 - Flight

13 - Glide

14 - Safefall