diff options
author | euphyy <euphyy@54d463be-8e91-2dee-dedb-b68131a5f0ec> | 2012-07-19 18:46:56 +0000 |
---|---|---|
committer | euphyy <euphyy@54d463be-8e91-2dee-dedb-b68131a5f0ec> | 2012-07-19 18:46:56 +0000 |
commit | cf6f0ee71e978691de28579ad33c0b30fdc8be09 (patch) | |
tree | 44a06d4e7fbdbe4e30d639a18635b78ff2033edd /doc | |
parent | 9275d18a5a462b676e8336b2c9957edb999634cc (diff) | |
download | hercules-cf6f0ee71e978691de28579ad33c0b30fdc8be09.tar.gz hercules-cf6f0ee71e978691de28579ad33c0b30fdc8be09.tar.bz2 hercules-cf6f0ee71e978691de28579ad33c0b30fdc8be09.tar.xz hercules-cf6f0ee71e978691de28579ad33c0b30fdc8be09.zip |
* Condensed the documentation on the "Import" folder, it should be more reader-friendly now (conf\readme.txt)
* Deleted doc\pccommand_list.txt, it's outdated and its contents are already (better) explained in doc\script_commands.txt
* Other misc cleaning...
git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@16453 54d463be-8e91-2dee-dedb-b68131a5f0ec
Diffstat (limited to 'doc')
-rw-r--r-- | doc/pccommand_list.txt | 169 | ||||
-rw-r--r-- | doc/sample/getequipcardid.txt | 1 | ||||
-rw-r--r-- | doc/sample/npc_shop_test.txt | 4 |
3 files changed, 1 insertions, 173 deletions
diff --git a/doc/pccommand_list.txt b/doc/pccommand_list.txt deleted file mode 100644 index 9bf97d270..000000000 --- a/doc/pccommand_list.txt +++ /dev/null @@ -1,169 +0,0 @@ ----> PC Command List -------> Here's a list of scripts that can be triggered by PC actions and what they do. -------> Configuration is found at conf/script_athena.conf -------> There are two methods to define the script to be use (event_script_type) -------> 0 - By NPC. There has to be an NPC named in the same manner as the event -------> 1 - By Label. Every label from every NPC with the event name will be - executed (note that in this case the event HAS to start with the - word 'On', eg: 'OnPCBaseLvUpEvent:') - -+ PCCommand: OnPCLoginEvent -+ Code by: (davidsiaw) -+ How it works: -When a player logs in, the NPC will run as if he just clicked it. Which means -if the script is like this: - -+ Sample: -prontera,0,0,0 script OnPCLoginEvent -1,{ - mes "lmao"; - close; - } - -+ Explaination: -every player who logs in will receive a message 'lmao' in their face as soon -as they can see the map. - -+ Note: - 1) The name of the NPC has to match the one specified in scripts_athena.conf - 2) I made it invisible because you don't need to see it. Its an abstract NPC - 3) If you don't want it, simply delete it - 4) If you have more than one only the first found will be execute (when using - event_script_type 0) - 5) You can put this script in ANY file. - 6) I put an end; there because that just makes it do nothing. - 7) Modify this script to your liking and give your players a surprise - 8) Remember: IT RUNS LIKE A NORMAL NPC. BUT THE ONLY WAY TO 'CLICK' IT IS BY - LOGGING ON - 9) There are 2 ways to use this - check the examples below! - ------------------------------------------------------------------------------ - -+ PCCommand: OnPcBaseLvUpEvent -+ Code by: lordalfa -+ How it works: -When a player Base level increases, the NPC will run as if he just clicked it. Which means -if the script is like this: - -+ Sample: -- Script OnPCBaseLvUpEvent -1,{ - mes "zomfg...."; - close; -} - -+ Explanation: -whenever a player level ups his/her base level, the words zomfg will pop up -in his face. - -+ Note: - 1) This script runs every moment the player gains a level. It is adviced if - you want to repeatedly use this script, to use a sort of filter. - 2) If a player gains multiple levels from a single kill, the script will be - only called once at the end. - ------------------------------------------------------------------------------ - -+ PCCommand: OnPcJobLvUpEvent -+ Code by: lordalfa -+ How it works: -It's exactly the same as OnPcBaseLvUpEvent, except it triggers when leveling job. - ------------------------------------------------------------------------------ - -+ PCCommand: OnOnNPCKillEvent -+ Code by: lordalfa -+ How it works: -When a player kills a monster, the NPC will run as if he just clicked it. Which means -if the script is like this: - -+ Sample: -- script OnNPCKillEvent -1,{ - mes "Holy shit"; - close; -} - -+ Explaination: -whenever a player kills a monster on the map, the words "Holy Shit" will appear -on the guy's face. - -+ Note: - 1) This script runs everytime a player kills a monster It is adviced if - you want to repeatedly use this script, to use a sort of filter. - 2) The var "KilledRid" is set on the killer, this can be used in - strmobinfo to find out info about the Monster that was killed ------------------------------------------------------------------------------ - -+ PCCommand: OnPCKillEvent -+ Code by: zbuffer aka Lance -+ How it works: -It is exactly the same as OnNPCKillEvent, except it triggers when a player kills another player. - ------------------------------------------------------------------------------ - -+ PCCommand: OnPCLoadMapEvent -+ Code by: zbuffer aka Lance -+ How it works: -When a player logs in on the map, the NPC will run as if he just clicked it. Which means -if the script is like this: - -+ Sample: -prontera,159,192,2 script OnPCLoadMapEvent 101,{ - mes "Holy shit"; - close; -} - -----or---> - -OnPCLoadMapEvent: - announce " " strcharinfo(0) + " has changed map!", 16; - end; - - + Note: - 1) Both types will execute regardless of map. - 2) The event will only trigger on maps where you enable the 'loadevent' mapflag. - ------------------------------------------------------------------------------ - -+ PCCommand: OnPCDieEvent -+ Code by: Unknown -+ How it works: -When a player dies, the event will be run as if a npc were clicked. The RID of the person killed -will be attached. Simple. It can to be used as a floating npc or as a npc placed on a map. -Notice that this event is server-wide if used as a floating npc, so if you try running it for -more than one map, and want to make a single npc, you'll have to use some sort of filter, which -can be getmapxy, something like this: - -- script PCDieEvent -1,{ -if (getmapxy(@mapname$,@mapx,@mapy,0) == -1) goto L_Finish; -if (@mapname$ == "valkyrie") || (@mapname$ == "amatsu") { -killmonster "valkyrie","All"; -announce "Deep Voice: You have failed.... you have another opportunity though...",bc_self,0x660033; -if (killtest != 0) enablenpc "Outern Voices"; -if (killedonce == 1) end; -set killedonce,1; -} else -end; - -L_Finish: - end; -} - -----or----> - -OnPCDieEvent: -if (getmapxy(@mapname$,@mapx,@mapy,0) == -1) goto L_Finish; -if (@mapname$ == "valkyrie") || (@mapname$ == "amatsu") { -killmonster "valkyrie","All"; -announce "Deep Voice: You have failed.... you have another opportunity though...",bc_self,0x660033; -if (killtest != 0) enablenpc "Outern Voices"; -if (killedonce == 1) end; -set killedonce,1; -} else -end; - -L_Finish: - end; - -We're using getmapxy to obtain the mapname, then adjust our commands and actions depending on the -map. We could also use the command to find if the player died inside a wished area. - ------------------------------------------------------------------------------ diff --git a/doc/sample/getequipcardid.txt b/doc/sample/getequipcardid.txt index 3449ed0c7..8cc321cbe 100644 --- a/doc/sample/getequipcardid.txt +++ b/doc/sample/getequipcardid.txt @@ -1,4 +1,3 @@ -//===== rAthena Script ======================================= //===== By: ================================================== //= Lupus //= Shows your HAT's slots IDs diff --git a/doc/sample/npc_shop_test.txt b/doc/sample/npc_shop_test.txt index 865bd0c13..ca0f9bfbc 100644 --- a/doc/sample/npc_shop_test.txt +++ b/doc/sample/npc_shop_test.txt @@ -27,6 +27,4 @@ prontera,218,211,4 shop Pet Groomer 125,537:2500,643:3000,10013:1500,10014:2000 izlude,164,138,4 shop Pet Groomer 124,537:2500,643:3000,10013:1500,10014:2000 morocc,269,167,4 shop Pet Groomer 125,537:2500,643:3000,10013:1500,10014:2000 geffen,193,152,4 shop Pet Groomer 124,537:2500,643:3000,10013:1500,10014:2000 -payon,142,104,4 shop Pet Groomer 124,537:2500,643:3000,10013:1500,10014:2000 - -// EOF //
\ No newline at end of file +payon,142,104,4 shop Pet Groomer 124,537:2500,643:3000,10013:1500,10014:2000
\ No newline at end of file |