Instance Dungeons Update

As requested by the community in http://hercules.ws/board/topic/1702-implement-rathena-npc/ we're merging in the latest of rAthena's dungeons, this includes the rewriting of all instance dungeons and the addition of 4 dungeons that were not present previously (BakonawaLake, BangungotHospital, BuwayaCave and OldGlastHeim).
Update also includes the ability for instances to reset (or be destroyed if instance files were disabled/removed) upon @reloadscript, instance scripts are able to control to what stage the instances are to be reset via the instance_set_respawn (reload spawn) script command, OnInstanceInit labels are now triggered when the instance starts via instance_init (and upon reload), they may be used alongside instance variables (which are persistent to @reloadscript) to save players' progress.

- NPC Changelog:
-- npc/instances/EndlessTower.txt
--- 2.2 Instance system rewrite. [Euphy]
--- 2.3 Added some missing announcements. [Euphy]
--- 2.4 Added GM management function. [Euphy]
-- npc/instances/NydhoggsNest.txt
--- 1.5 Instance system rewrite. [Euphy]
--- 1.6 Added GM management NPCs. [Euphy]
-- npc/instances/OrcsMemory.txt
--- 1.7 Instance system rewrite. [Euphy]
-- npc/instances/SealedShrine.txt
--- 2.3 Instance system rewrite. [Euphy]
-- npc/other/gm_npcs.txt
--- 1.0 First version. [Euphy]
-- npc/re/instances/BakonawaLake.txt
--- 1.0 First version. [Euphy]
--- 1.1 Added GM management NPC. [Euphy]
-- npc/re/instances/BangungotHospital.txt
--- 1.0 First version. [Euphy]
--- 1.1 Added GM management function. [Euphy]
-- npc/re/instances/BuwayaCave.txt
--- 1.0 First version. [Euphy]
-- npc/re/instances/HazyForest.txt
--- 1.1 Instance system rewrite. [Euphy]
-- npc/re/instances/MalangdoCulvert.txt
--- 1.0b Fixed incorrect use of 'close'. [Joseph]
--- 1.1 Instance system rewrite. [Euphy]
-- npc/re/instances/OctopusCave.txt
--- 1.1 Instance system rewrite. [Euphy]
-- npc/re/instances/OldGlastHeim.txt
--- 1.0 First version. [Euphy]

Special Thanks to Haru, Uziel for their contributions to this update, and ossi0110 for helping us debug it.

Signed-off-by: shennetsind <ind@henn.et>

1 files changed, 150 insertions, 0 deletions

diff --git a/npc/other/gm_npcs.txt b/npc/other/gm_npcs.txt
new file mode 100644
index 000000000..076cbf025
--- /dev/null
+++ b/npc/other/gm_npcs.txt
@@ -0,0 +1,150 @@
+//===== Hercules Script ====================================== 
+//= GM Management NPCs
+//===== By: ================================================== 
+//= Euphy
+//===== Current Version: ===================================== 
+//= 1.0
+//===== Description: ========================================= 
+//= Controls the official GM management NPCs in certain scripts.
+//===== Additional Comments: ================================= 
+//= 1.0 First version.
+//============================================================ 
+
+// callfunc("F_GM_NPC"{,<password>,<0:int | 1:str>{,<min>,<max>}})
+function	script	F_GM_NPC	{
+
+	// To disable all GM NPCs, uncomment the line below.
+	//end;
+
+	// To set a minimum GM level to access the NPCs, edit the line below.
+	if (getgmlevel() < 99) {/* TODO: perhaps better to just add a group permission? [Ind] */
+		// Log the event.
+		getmapxy(.@map$,.@x,.@y,1);
+		logmes strcharinfo(0)+" attempted to access GM NPC "+strnpcinfo(0)+" ("+.@map$+","+.@x+","+.@y+").";
+		end;
+	}
+
+	if (!getargcount()) return;
+
+	// To disable password inputs, uncomment the line below.
+	//return 1;
+
+	// Password return values:
+	//  1: correct input
+	//  0: incorrect input
+	// -1: zero/cancel (integer only)
+	// -2: out of bounds (integer only)
+	if (getarg(1) == 0) {
+		// Integer password
+		if (getarg(3,0)) {
+			set .@error, input(.@input,getarg(2),getarg(3));
+			if (.@error)
+				return -2;
+		} else
+			input .@input;
+		if (.@input == 0)
+			return -1;
+		else
+			return (.@input == getarg(0))?1:0;
+	} else {
+		// String password
+		input .@inputstr$;
+		return (.@inputstr$ == getarg(0))?1:0;
+	}
+}
+
+/*
+List of GM Management NPCs (incomplete)
+--------------------------
+[ Battleground ]
+- Switch#batgnd
+- Release all#b01
+- Release all#b02
+- Release all#a01
+- Release all#a02
+
+[ Guild-related ]
+- Event controller#aru_gd
+- Event controller#sch_gd
+- Festival Manager#gq_fes0
+- Festival Manager#gq_fes2
+- Godly Item Quests#god
+- Golbal var
+- Investment_total#fund00 (RE)
+
+[ Instances ]
+------ Endless Tower -----
+- #102Administrator Mode
+- Purification Stone#et2
+- #Manager Mode1
+- #Manager Mode2
+- #Manager Mode3
+- #Manager Mode4
+- #Manager Mode5
+--------------------------
+- Nidhoggur Manager
+- Purification Admin#nyd2
+- Bakonawa's Rage (RE)
+- Bangungot Gate (RE)
+
+[ Job-related ]
+----- 3rd Class (RE) -----
+- control#arch
+- #GMhelper01_gc
+- #GMhelper02_gc
+- Worker#job_ranger
+- R.Knight Job Manager
+- #renshucheck
+- sorcereryal
+- Button Girl#wl
+- Button Girl#sura
+--------------------------
+- Soul Linker Var
+- 1st Job Quest Reset
+- Job Repair (RE)
+
+[ Quest ]
+--------- Renewal --------
+- 13.3 Related Reset
+- Scaraba Dungeon Entrance
+- Assistant#para_suvquest
+- Guidance for quest#ml
+- Initializing Mora Sanjo
+- Theore Set Guid
+- Field Bush Switch
+- Bakonawa Intro Helper
+- Pintados Manager#pin
+--------------------------
+- Allied Manager#gm
+- #timer_alba01
+- Translator Preparation#1
+- ep13_nd2f_mng
+- Factory Quest Test
+- boss::lght_boss_admin
+- #LyozienSwitch
+- Juperos Manager
+- Extra Story Patch
+- boss::boss_aru_monas
+- Koshei GlobalVar#admin
+- Morroc GlobalVar Admin::MorrocAdmin_sec
+- Morroc GlobalVar Admin::MorrocAdmin_moc
+- Morroc Invasion Manager (disabled)
+
+[ Other ]
+-------- Marriage --------
+- The King of Midgart
+- Divorce Staff
+- Remarry Staff
+------ Izlude Arena ------
+- log-on-aco#arena
+- acolink#arena
+- Arena Manager#arena
+- Reward Manager#arena
+- Picture Manager#arena
+- Live Broadcast#arena
+- #arenacontrol
+--------------------------
+- Monster Race Manager
+- Vote Globalvar Girl#yuno (disabled)
+
+*/