summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorthatakkarin <thatakkarin@54d463be-8e91-2dee-dedb-b68131a5f0ec>2012-09-03 23:59:46 +0000
committerthatakkarin <thatakkarin@54d463be-8e91-2dee-dedb-b68131a5f0ec>2012-09-03 23:59:46 +0000
commit5d08bc2a59ac0bea9573085f6ea2fc12fee9a7ae (patch)
treecba96df072699040b4372aee6767a1ba1653f0a8 /doc
parent6329c98d4af9afb03bbe9b31ed9291f010c53dec (diff)
downloadhercules-5d08bc2a59ac0bea9573085f6ea2fc12fee9a7ae.tar.gz
hercules-5d08bc2a59ac0bea9573085f6ea2fc12fee9a7ae.tar.bz2
hercules-5d08bc2a59ac0bea9573085f6ea2fc12fee9a7ae.tar.xz
hercules-5d08bc2a59ac0bea9573085f6ea2fc12fee9a7ae.zip
* Fixed bugreport:6619 with correct ammo view id in /doc/item_db.txt
* Slight cleanup in /doc/atcommands.txt * Added quest sample NPC in /doc/npc_test_quest.txt * Added an additional example in /doc/whisper_sys.txt to show extended usage git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@16742 54d463be-8e91-2dee-dedb-b68131a5f0ec
Diffstat (limited to 'doc')
-rw-r--r--doc/atcommands.txt15
-rw-r--r--doc/item_db.txt6
-rw-r--r--doc/sample/npc_test_quest.txt44
-rw-r--r--doc/whisper_sys.txt32
4 files changed, 88 insertions, 9 deletions
diff --git a/doc/atcommands.txt b/doc/atcommands.txt
index d72246de5..a8880eb67 100644
--- a/doc/atcommands.txt
+++ b/doc/atcommands.txt
@@ -1122,7 +1122,9 @@ Opens the trade window with the specified player.
---------------------------------------
-@changelook: Changes the player's appearance (headgear).
+@changelook <ID>
+
+Changes the player's appearance (headgear).
---------------------------------------
@@ -1202,19 +1204,20 @@ Toggles the visibility of an NPC's sprite.
---------------------------------------
-@shownpc: Unhides a NPC.
-
-
----------------------------------------
@loadnpc <path>
Loads an NPC script by path.
-
+
+Example:
+@loadnpc npc/custom/jobmaster.txt
---------------------------------------
@unloadnpc <NPC Name>
Unloads an NPC.
+
+Example:
+@unloadnpc Job Master
---------------------------------------
diff --git a/doc/item_db.txt b/doc/item_db.txt
index ddbac4238..a74ef0617 100644
--- a/doc/item_db.txt
+++ b/doc/item_db.txt
@@ -3,7 +3,7 @@
//===== By: ==================================================
//= rAthena Dev Team
//===== Current Version: =====================================
-//= 20120420
+//= 20120904
//===== Description: =========================================
//= Explanation of the item_db.txt file and structure.
//============================================================
@@ -143,8 +143,8 @@ View: For normal items, defines a replacement view-sprite for the item (eg:
5: Grenades
6: Shuriken
7: Kunai
- 7: Cannonballs
- 7: Throwable Items (Sling Item)
+ 8: Cannonballs
+ 9: Throwable Items (Sling Item)
Script: Script to execute when the item is used/equipped.
diff --git a/doc/sample/npc_test_quest.txt b/doc/sample/npc_test_quest.txt
new file mode 100644
index 000000000..097f7655b
--- /dev/null
+++ b/doc/sample/npc_test_quest.txt
@@ -0,0 +1,44 @@
+// Before installing an NPC like the one below, you would
+// need to add the quest to /db/quest_db.txt - e.g:
+// 9000,0,1002,3,0,0,0,0,"3 Splats Please!"
+
+
+prontera,90,95,1 script Jelly 123,{
+set .@n$, "["+strnpcinfo(1)+"]";
+if(checkquest(9000) == -1) goto L_Start;
+if(checkquest(9000,HUNTING) == 2) goto L_Reward;
+if(checkquest(9000) == 2) goto L_Done;
+
+L_Start:
+ mes .@n$;
+ mes "Hey there! Would you help me?";
+ next;
+ switch(select("I'd rather not:What's up?")){
+ case 1:
+ mes .@n$;
+ mes "I didn't want your help anyway!";
+ close;
+
+ case 2:
+ mes .@n$;
+ mes "Those Porings are weirding me out.";
+ mes "Would you kill 3 for me?";
+ setquest 9000; // Adds the quest to your Quest Window.
+ close;
+ }
+ }
+ close;
+
+L_Reward:
+ mes .@n$;
+ mes "Awesome! Than you =)";
+ getexp 10000,0;
+ dispbottom "You have been rewarded with 10,000 Base Exp.";
+ completequest 9000;
+ close;
+
+L_Done:
+ mes .@n$;
+ mes "Thanks again for doing that for me =)";
+ close;
+} \ No newline at end of file
diff --git a/doc/whisper_sys.txt b/doc/whisper_sys.txt
index bb726974b..3593c486c 100644
--- a/doc/whisper_sys.txt
+++ b/doc/whisper_sys.txt
@@ -36,3 +36,35 @@ OnWhisperGlobal:
message @whispervar2$,"You have been reported for "+@whispervar1$+".";
end;
}
+
+The Whisper System is also useful for hidden event handler NPCs (NPCs that don't
+have a sprite on a map for you to click). E.g:
+
+OnWhisperGlobal:
+if (getgmlevel()<80) goto L_NotGM;
+if (@whispervar0$ == "event1") goto L_Event1;
+if (@whispervar0$ == "event2") goto L_Event2;
+if (@whispervar0$ == "event3") goto L_Event3;
+
+// If the string sent to this NPC doesn't contain any of the above:
+else goto L_NoVar;
+end;
+
+L_NotGM:
+ dispbottom "NPC : You do not have sufficient access to whisper in my ear.";
+ end;
+
+L_NoVar:
+ dispbottom "NPC : Sorry, i do not recognise that command.";
+ end;
+
+L_Event1:
+ if (@whispervar1$ == "start"){
+ // Execute scripts to start Event1
+ }
+ if (@whispervar1$ == "stop"){
+ //Execute scripts to forcefully stop Event1
+ }
+
+
+