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

10 files changed, 36 insertions, 36 deletions

diff --git a/npc/other/acolyte_warp.txt b/npc/other/acolyte_warp.txt
index 1b5404a78..256c2d802 100644
--- a/npc/other/acolyte_warp.txt
+++ b/npc/other/acolyte_warp.txt
@@ -75,9 +75,9 @@ prontera,98,121,4	script	Acolyte#Prtclear	4_F_01,{
 			mes "to "+.@towns$[.@i]+" is "+.@cost[.@i]+" zeny.";
 			close;
 		}
-		specialeffect2 EF_READYPORTAL;
-		specialeffect2 EF_TELEPORTATION;
-		specialeffect2 EF_PORTAL;
+		specialeffect(EF_READYPORTAL, AREA, playerattached());
+		specialeffect(EF_TELEPORTATION, AREA, playerattached());
+		specialeffect(EF_PORTAL, AREA, playerattached());
 		next;
 		Zeny -= .@cost[.@i];
 		switch(.@i) {
@@ -138,9 +138,9 @@ yuno,142,184,6	script	Acolyte#Junoclear	4_F_01,{
 			mes "to "+.@towns$[.@i]+" is "+.@cost[.@i]+" zeny.";
 			close;
 		}
-		specialeffect2 EF_READYPORTAL;
-		specialeffect2 EF_TELEPORTATION;
-		specialeffect2 EF_PORTAL;
+		specialeffect(EF_READYPORTAL, AREA, playerattached());
+		specialeffect(EF_TELEPORTATION, AREA, playerattached());
+		specialeffect(EF_PORTAL, AREA, playerattached());
 		next;
 		Zeny -= .@cost[.@i];
 		switch(.@i) {
diff --git a/npc/other/arena/arena_aco.txt b/npc/other/arena/arena_aco.txt
index 0c46eea21..99971eecd 100644
--- a/npc/other/arena/arena_aco.txt
+++ b/npc/other/arena/arena_aco.txt
@@ -1089,7 +1089,7 @@ prt_are_in,181,83,3	script	Staff#aco-1	1_F_02,{
 	mes "I hope you enjoyed";
 	mes "your battle in the area~";
 	close2;
-	specialeffect2 EF_EXIT;
+	specialeffect(EF_EXIT, AREA, playerattached());
 	warp "arena_room",100,75;
 	end;
 }
@@ -1289,7 +1289,7 @@ prt_are_in,25,31,3	script	Staff#aco-2	1_F_02,{
 				close2;
 				arena_point += 50;
 			}
-			specialeffect2 EF_EXIT;
+			specialeffect(EF_EXIT, AREA, playerattached());
 			warp "arena_room",100,75;
 			donpcevent "#arn_timer_aco::OnStop";
 			donpcevent "allkill#aco::OnEnable";
@@ -1353,7 +1353,7 @@ prt_are_in,25,31,3	script	Staff#aco-2	1_F_02,{
 				close2;
 				arena_point += 20;
 			}
-			specialeffect2 EF_EXIT;
+			specialeffect(EF_EXIT, AREA, playerattached());
 			warp "arena_room",100,75;
 			donpcevent "#arn_timer_aco::OnStop";
 			donpcevent "allkill#aco::OnEnable";
@@ -1451,7 +1451,7 @@ prt_are_in,25,31,3	script	Staff#aco-2	1_F_02,{
 				close2;
 				arena_point += 20;
 			}
-			specialeffect2 EF_EXIT;
+			specialeffect(EF_EXIT, AREA, playerattached());
 			warp "arena_room",100,75;
 			donpcevent "#arn_timer_aco::OnStop";
 			donpcevent "allkill#aco::OnEnable";
diff --git a/npc/other/arena/arena_lvl50.txt b/npc/other/arena/arena_lvl50.txt
index fbd2ba193..32bd12178 100644
--- a/npc/other/arena/arena_lvl50.txt
+++ b/npc/other/arena/arena_lvl50.txt
@@ -818,7 +818,7 @@ prt_are_in,129,188,3	script	Staff#50-1	1_F_02,{
 	mes "[Staff]";
 	mes "Let me guide you outside. I hope you had a good time.";
 	close2;
-	specialeffect2 EF_EXIT;
+	specialeffect(EF_EXIT, AREA, playerattached());
 	warp "arena_room",100,75;
 	end;
 }
@@ -884,7 +884,7 @@ prt_are_in,25,188,3	script	Staff#50-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_EXIT;
+		specialeffect(EF_EXIT, AREA, playerattached());
  		donpcevent "cast#50::OnNomal1";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_50::OnStop";
@@ -931,7 +931,7 @@ prt_are_in,25,188,3	script	Staff#50-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_HIT5;
+		specialeffect(EF_HIT5, AREA, playerattached());
  		donpcevent "cast#50::OnNomal2";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_50::OnStop";
diff --git a/npc/other/arena/arena_lvl60.txt b/npc/other/arena/arena_lvl60.txt
index b81831345..30734f043 100644
--- a/npc/other/arena/arena_lvl60.txt
+++ b/npc/other/arena/arena_lvl60.txt
@@ -828,7 +828,7 @@ prt_are_in,129,135,3	script	Staff#60-1	1_F_02,{
 	mes "[Staff]";
 	mes "Let me guide you outside. I hope you had a good time.";
 	close2;
-	specialeffect2 EF_EXIT;
+	specialeffect(EF_EXIT, AREA, playerattached());
 	warp "arena_room",100,75;
 	end;
 }
@@ -894,7 +894,7 @@ prt_are_in,25,135,3	script	Staff#60-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_EXIT;
+		specialeffect(EF_EXIT, AREA, playerattached());
  		donpcevent "cast#60::OnNomal1";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_60::OnStop";
@@ -941,7 +941,7 @@ prt_are_in,25,135,3	script	Staff#60-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_HIT5;
+		specialeffect(EF_HIT5, AREA, playerattached());
  		donpcevent "cast#60::OnNomal2";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_60::OnStop";
diff --git a/npc/other/arena/arena_lvl70.txt b/npc/other/arena/arena_lvl70.txt
index c862585aa..9a0c26aa3 100644
--- a/npc/other/arena/arena_lvl70.txt
+++ b/npc/other/arena/arena_lvl70.txt
@@ -793,7 +793,7 @@ prt_are_in,129,83,3	script	Staff#70-1	1_F_02,{
 	mes "[Staff]";
 	mes "Let me guide you outside. I hope you had a good time.";
 	close2;
-	specialeffect2 EF_EXIT;
+	specialeffect(EF_EXIT, AREA, playerattached());
 	warp "arena_room",100,75;
 	end;
 }
@@ -859,7 +859,7 @@ prt_are_in,25,84,3	script	Staff#70-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_EXIT;
+		specialeffect(EF_EXIT, AREA, playerattached());
  		donpcevent "cast#70::OnNomal1";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_70::OnStop";
@@ -906,7 +906,7 @@ prt_are_in,25,84,3	script	Staff#70-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_HIT5;
+		specialeffect(EF_HIT5, AREA, playerattached());
  		donpcevent "cast#70::OnNomal2";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_70::OnStop";
diff --git a/npc/other/arena/arena_lvl80.txt b/npc/other/arena/arena_lvl80.txt
index 044b1eb31..3bb1cf43a 100644
--- a/npc/other/arena/arena_lvl80.txt
+++ b/npc/other/arena/arena_lvl80.txt
@@ -774,7 +774,7 @@ prt_are_in,181,188,3	script	Staff#80-1	1_F_02,{
 	mes "[Staff]";
 	mes "Let me guide you outside. I hope you had a good time.";
 	close2;
-	specialeffect2 EF_EXIT;
+	specialeffect(EF_EXIT, AREA, playerattached());
 	warp "arena_room",100,75;
 	end;
 }
@@ -840,7 +840,7 @@ prt_are_in,77,187,3	script	Staff#80-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_EXIT;
+		specialeffect(EF_EXIT, AREA, playerattached());
  		donpcevent "cast#80::OnNomal1";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_80::OnStop";
@@ -887,7 +887,7 @@ prt_are_in,77,187,3	script	Staff#80-2	1_F_02,{
 			mes "See you later~";
 			close2;
 		}
-		specialeffect2 EF_HIT5;
+		specialeffect(EF_HIT5, AREA, playerattached());
  		donpcevent "cast#80::OnNomal2";
 		warp "arena_room",100,75;
 		donpcevent "#arn_timer_80::OnStop";
diff --git a/npc/other/arena/arena_party.txt b/npc/other/arena/arena_party.txt
index d7865d441..c3133af30 100644
--- a/npc/other/arena/arena_party.txt
+++ b/npc/other/arena/arena_party.txt
@@ -986,7 +986,7 @@ prt_are_in,181,135,3	script	Staff#party-1	1_F_02,{
 	mes "[Staff]";
 	mes "Let me guide you outside. I hope you had a good time.";
 	close2;
-	specialeffect2 EF_HIT5;
+	specialeffect(EF_HIT5, AREA, playerattached());
 	warp "arena_room",100,75;
 	end;
 }
@@ -1058,7 +1058,7 @@ prt_are_in,77,135,3	script	Staff#party-2	1_F_02,{
 			donpcevent "alloff#pt::OnEnable";
 			donpcevent "Ponox::OnStart";
 		}
-		specialeffect2 EH_HIT5;
+		specialeffect(EH_HIT5, AREA, playerattached());
  		donpcevent "cast#pt::OnNomal1";
 		warp "arena_room",100,75;
 		end;
@@ -1136,7 +1136,7 @@ prt_are_in,77,135,3	script	Staff#party-2	1_F_02,{
 			donpcevent "alloff#pt::OnEnable";
 			donpcevent "Ponox::OnStart";
 		}
-		specialeffect2 EF_HIT5;
+		specialeffect(EF_HIT5, AREA, playerattached());
 		warp "arena_room",100,75;
 		end;
 	}
diff --git a/npc/other/divorce.txt b/npc/other/divorce.txt
index e3d6f5ee7..f490df2f9 100644
--- a/npc/other/divorce.txt
+++ b/npc/other/divorce.txt
@@ -208,7 +208,7 @@ nif_in,190,112,5	script	Deviruchi#divorce	4_DEVIRUCHI,{
 		mes "^FF0000for the rest of your life.^000000";
 		next;
 		specialeffect EF_MAGICROD;
-		specialeffect2 EF_DEVIL;
+		specialeffect(EF_DEVIL, AREA, playerattached());
 		wedding_sign = 0;
 		Zeny -= 2500000;
 		Sp = 0;
diff --git a/npc/other/gympass.txt b/npc/other/gympass.txt
index d30fafeb8..50f7b18f7 100644
--- a/npc/other/gympass.txt
+++ b/npc/other/gympass.txt
@@ -80,13 +80,13 @@ payon,173,141,4	script	Ripped Cabus#GymPass	4_M_HUMAN_02,{
 				mes "and try to feel the burn.";
 				mes "Ready? Let's do this.";
 				next;
-				specialeffect2 EF_EARTHSPIKE;
+				specialeffect(EF_EARTHSPIKE, AREA, playerattached());
 				next;
-				specialeffect2 EF_DEVIL;
+				specialeffect(EF_DEVIL, AREA, playerattached());
 				next;
-				specialeffect2 EF_COIN;
+				specialeffect(EF_COIN, AREA, playerattached());
 				next;
-				specialeffect2 EF_SIGHTRASHER;
+				specialeffect(EF_SIGHTRASHER, AREA, playerattached());
 				next;
 				mes "[Ripped]";
 				mes "There, you should be able";
@@ -139,13 +139,13 @@ payon,173,141,4	script	Ripped Cabus#GymPass	4_M_HUMAN_02,{
 			mes "as muscle memory. It's won't take";
 			mes "as long to build 'em back up...";
 			next;
-			specialeffect2 EF_EARTHSPIKE;
+			specialeffect(EF_EARTHSPIKE, AREA, playerattached());
 			next;
-			specialeffect2 EF_DEVIL;
+			specialeffect(EF_DEVIL, AREA, playerattached());
 			next;
-			specialeffect2 EF_COIN;
+			specialeffect(EF_COIN, AREA, playerattached());
 			next;
-			specialeffect2 EF_SIGHTRASHER;
+			specialeffect(EF_SIGHTRASHER, AREA, playerattached());
 			next;
 			mes "[Ripped]";
 			mes "How about that?";
diff --git a/npc/other/poring_war.txt b/npc/other/poring_war.txt
index b3e0eb15a..d89bb3fed 100644
--- a/npc/other/poring_war.txt
+++ b/npc/other/poring_war.txt
@@ -1052,7 +1052,7 @@ OnInit:
 
 OnEnable:
 	enablenpc "#wop_warp_a";
-	specialeffect EF_MAPPILLAR2,AREA,"#wop_warp_a";
+	specialeffect(EF_MAPPILLAR2, AREA, getnpcid(0, "#wop_warp_a"));
 	end;
 
 OnDisable:
@@ -1074,7 +1074,7 @@ OnInit:
 
 OnEnable:
 	enablenpc "#wop_warp_d";
-	specialeffect EF_MAPPILLAR2,AREA,"#wop_warp_d";
+	specialeffect(EF_MAPPILLAR2, AREA, getnpcid(0, "#wop_warp_d"));
 	end;
 
 OnDisable: