Unify specialeffect, convert legacy scripts (#1746)

* allow to use specialeffect() on any unit, and to send to any player

* update the documentation for specialeffect()

* remove specialeffect2 from databases

* remove specialeffect2 from npcs

* remove misceffect from npcs

* convert specialeffect calls with strings to use GID

* add missing constants to specialeffect calls

* flag specialeffect2() as deprecated

* flag misceffect() as deprecated

7 files changed, 35 insertions, 35 deletions

diff --git a/npc/custom/battleground/bg_flavius_01.txt b/npc/custom/battleground/bg_flavius_01.txt
index 0520902ba..73ab603c9 100644
--- a/npc/custom/battleground/bg_flavius_01.txt
+++ b/npc/custom/battleground/bg_flavius_01.txt
@@ -333,7 +333,7 @@ bat_b01,390,13,5	script	Therapist in battle#fl12	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -341,7 +341,7 @@ bat_b01,10,293,5	script	Therapist in battle#fl11	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -360,7 +360,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000:
@@ -382,7 +382,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000:
diff --git a/npc/custom/battleground/bg_flavius_02.txt b/npc/custom/battleground/bg_flavius_02.txt
index da6c9cfef..e970a0711 100644
--- a/npc/custom/battleground/bg_flavius_02.txt
+++ b/npc/custom/battleground/bg_flavius_02.txt
@@ -333,7 +333,7 @@ bat_b02,390,13,5	script	Therapist in battle#fl22	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -341,7 +341,7 @@ bat_b02,10,293,5	script	Therapist in battle#fl21	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -360,7 +360,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000:
@@ -382,7 +382,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000:
diff --git a/npc/custom/battleground/bg_kvm01.txt b/npc/custom/battleground/bg_kvm01.txt
index c27e042a2..a66e202e3 100644
--- a/npc/custom/battleground/bg_kvm01.txt
+++ b/npc/custom/battleground/bg_kvm01.txt
@@ -35,9 +35,9 @@ OnEnterBG:
 bat_c01,54,123,0	script	#bat_c01a	HIDDEN_NPC,{
 	end;
 
-OnKvM01LightA: misceffect 54; end;
-OnKvM01LightB: misceffect 55; end;
-OnKvM01LightC: misceffect 56; end;
+OnKvM01LightA: specialeffect(EF_BEGINSPELL2); end;
+OnKvM01LightB: specialeffect(EF_BEGINSPELL3); end;
+OnKvM01LightC: specialeffect(EF_BEGINSPELL4); end;
 }
 
 bat_c01,56,125,0	duplicate(#bat_c01a)	#bat_c01b	HIDDEN_NPC
@@ -286,7 +286,7 @@ bat_c01,51,130,5	script	Therapist in battle::TherapistKvM01a	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -294,7 +294,7 @@ bat_c01,148,53,1	script	Therapist in battle::TherapistKvM01b	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
diff --git a/npc/custom/battleground/bg_kvm02.txt b/npc/custom/battleground/bg_kvm02.txt
index cd13241cb..f1637069a 100644
--- a/npc/custom/battleground/bg_kvm02.txt
+++ b/npc/custom/battleground/bg_kvm02.txt
@@ -35,9 +35,9 @@ OnEnterBG:
 bat_c02,54,123,0	script	#bat_c02a	HIDDEN_NPC,{
 	end;
 
-OnKvM02LightA: misceffect 54; end;
-OnKvM02LightB: misceffect 55; end;
-OnKvM02LightC: misceffect 56; end;
+OnKvM02LightA: specialeffect(EF_BEGINSPELL2); end;
+OnKvM02LightB: specialeffect(EF_BEGINSPELL3); end;
+OnKvM02LightC: specialeffect(EF_BEGINSPELL4); end;
 }
 
 bat_c02,56,125,0	duplicate(#bat_c02a)	#bat_c02b	HIDDEN_NPC
@@ -286,7 +286,7 @@ bat_c02,51,130,5	script	Therapist in battle::TherapistKvM02a	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -294,7 +294,7 @@ bat_c02,148,53,1	script	Therapist in battle::TherapistKvM02b	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
diff --git a/npc/custom/battleground/bg_kvm03.txt b/npc/custom/battleground/bg_kvm03.txt
index 3ec87355e..612047dcb 100644
--- a/npc/custom/battleground/bg_kvm03.txt
+++ b/npc/custom/battleground/bg_kvm03.txt
@@ -35,9 +35,9 @@ OnEnterBG:
 bat_c03,54,123,0	script	#bat_c03a	HIDDEN_NPC,{
 	end;
 
-OnKvM03LightA: misceffect 54; end;
-OnKvM03LightB: misceffect 55; end;
-OnKvM03LightC: misceffect 56; end;
+OnKvM03LightA: specialeffect(EF_BEGINSPELL2); end;
+OnKvM03LightB: specialeffect(EF_BEGINSPELL3); end;
+OnKvM03LightC: specialeffect(EF_BEGINSPELL4); end;
 }
 
 bat_c03,56,125,0	duplicate(#bat_c03a)	#bat_c03b	HIDDEN_NPC
@@ -286,7 +286,7 @@ bat_c03,51,130,5	script	Therapist in battle::TherapistKvM03a	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -294,7 +294,7 @@ bat_c03,148,53,1	script	Therapist in battle::TherapistKvM03b	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
diff --git a/npc/custom/battleground/bg_tierra_01.txt b/npc/custom/battleground/bg_tierra_01.txt
index 56a505356..2640723b3 100644
--- a/npc/custom/battleground/bg_tierra_01.txt
+++ b/npc/custom/battleground/bg_tierra_01.txt
@@ -381,7 +381,7 @@ bat_a01,53,377,3	script	Guillaume Vintenar#tv1	4_M_KY_HEAD,{
 bat_a01,60,216,3	script	Ghost#tv13	4_GHOSTRING,{
 	mes "[Ghost in valley]";
 	mes "Boo...Boo...";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -389,7 +389,7 @@ bat_a01,53,377,3	script	Therapist in battle#tv12	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -397,7 +397,7 @@ bat_a01,45,18,3	script	Therapist in battle#tv11	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -416,7 +416,7 @@ OnBGStop:
 	end;
 
 OnTimer19000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer20000:
@@ -438,7 +438,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000:
@@ -460,7 +460,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000:
diff --git a/npc/custom/battleground/bg_tierra_02.txt b/npc/custom/battleground/bg_tierra_02.txt
index e0f1b402a..98b604fd7 100644
--- a/npc/custom/battleground/bg_tierra_02.txt
+++ b/npc/custom/battleground/bg_tierra_02.txt
@@ -381,7 +381,7 @@ bat_a02,53,377,3	script	Guillaume Vintenar#tv2	4_M_KY_HEAD,{
 bat_a02,60,216,3	script	Ghost#tv23	4_GHOSTRING,{
 	mes "[Ghost in valley]";
 	mes "Boo...Boo...";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -389,7 +389,7 @@ bat_a02,53,377,3	script	Therapist in battle#tv22	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -397,7 +397,7 @@ bat_a02,45,18,3	script	Therapist in battle#tv21	4_F_SISTER,{
 	mes "[Therapist in battle]";
 	mes "Just close your eyes, and take a deep breathe.";
 	mes "You can be free from pain.";
-	specialeffect2 312;
+	specialeffect(EF_HEAL, AREA, playerattached());
 	close;
 }
 
@@ -416,7 +416,7 @@ OnBGStop:
 	end;
 
 OnTimer19000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer20000:
@@ -438,7 +438,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000:
@@ -460,7 +460,7 @@ OnBGStop:
 	end;
 
 OnTimer24000:
-	misceffect 83;
+	specialeffect(EF_SANCTUARY);
 	end;
 
 OnTimer25000: