* For the sake of avoiding confusion, all script events are named with prefix 'On' from now on.

modified   Changelog-Trunk.txt
modified   conf-tmpl/script_athena.conf
modified   doc/pccommand_list.txt
modified   doc/script_commands.txt
modified   npc/custom/Lance/FR_HallOfFame.c
modified   npc/sample/PCLoginEvent.txt


git-svn-id: https://svn.code.sf.net/p/rathena/svn/trunk@9231 54d463be-8e91-2dee-dedb-b68131a5f0ec

Changelog-Trunk.txt

@@ -4,6 +4,8 @@ AS OF SVN REV. 5091, WE ARE NOW USING TRUNK.  ALL UNTESTED BUGFIXES/FEATURES GO
 IF YOU HAVE A WORKING AND TESTED BUGFIX PUT IT INTO STABLE AS WELL AS TRUNK.
 
 2006/11/16
+	* For the sake of avoiding confusion, all script events are named with prefix 'On'
+	  from now on. [Lance]
 	* Edited atcommand and charcommand syntax. Now it doesn't need the useless
 	  character name and ":". [Lance]
 	* Shadow Jump and Kirikage won't "move" you if you use them in GvG grounds.

conf-tmpl/script_athena.conf

@@ -47,7 +47,7 @@ event_script_type: 0
 event_requires_trigger: no
 
 // Name of event when a player has died
-die_event_name: PCDieEvent
+die_event_name: OnPCDieEvent
 
 // Name of event when a player kills a player
 kill_pc_event_name: OnPCKillEvent
@@ -56,17 +56,17 @@ kill_pc_event_name: OnPCKillEvent
 kill_mob_event_name: OnNPCKillEvent
 
 // Name of event when a player logs out
-logout_event_name: PCLogoutEvent
+logout_event_name: OnPCLogoutEvent
 
 // Name of event when a player logs in
-login_event_name: PCLoginEvent
+login_event_name: OnPCLoginEvent
 
 // Name of event when a player changes map
 // NOTE: This event will only trigger on maps with the "loadevent" flag active.
-loadmap_event_name: PCLoadMapEvent
+loadmap_event_name: OnPCLoadMapEvent
 
 // Name of event when a player levels up (base lv)
-baselvup_event_name: PCBaseLvUpEvent
+baselvup_event_name: OnPCBaseLvUpEvent
 
 // Name of event when a player levels up (job lv)
-joblvup_event_name: PCJobLvUpEvent
+joblvup_event_name: OnPCJobLvUpEvent

doc/pccommand_list.txt

@@ -7,14 +7,14 @@
             executed (note that in this case the event HAS to start with the 
             word 'On', eg: 'OnPCBaseLvUpEvent:')
 
-+ PCCommand: PCLoginEvent
++ 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.gat,0,0,0	script	PCLoginEvent	-1,{
+prontera.gat,0,0,0	script	OnPCLoginEvent	-1,{
 	mes "lmao";
 	close;
  }
@@ -38,14 +38,14 @@ as they can see the map.
 
 -----------------------------------------------------------------------------
 
-+ PCCommand: PcBaseLvUpEvent
++ 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	PCBaseLvUpEvent	-1,{
+-	Script	OnPCBaseLvUpEvent	-1,{
 	mes "zomfg....";
 	close;
 }
@@ -62,14 +62,14 @@ in his face.
 
 -----------------------------------------------------------------------------
 
-+ PCCommand: PcJobLvUpEvent
++ PCCommand: OnPcJobLvUpEvent
 + Code by: lordalfa
 + How it works:
-It's exactly the same as PcBaseLvUpEvent, except it triggers when leveling job.
+It's exactly the same as OnPcBaseLvUpEvent, except it triggers when leveling job.
 
 -----------------------------------------------------------------------------
 
-+ PCCommand: OnNPCKillEvent
++ 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
@@ -99,14 +99,14 @@ It is exactly the same as OnNPCKillEvent, except it triggers when a player kills
 
 -----------------------------------------------------------------------------
 
-+ PCCommand: PCLoadMapEvent
++ 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.gat,159,192,2 script PCLoadMapEvent 101,{
+prontera.gat,159,192,2 script OnPCLoadMapEvent 101,{
    mes "Holy shit";
    close;
 }

doc/script_commands.txt

@@ -675,10 +675,10 @@ This label will be executed if a trigger area is defined for the NPC object it's
 in. If it isn't present, the execution will start from the beginning of the NPC 
 code. The RID of the triggering character object will be attached.
 
-PCDieEvent:
-PCKillEvent:
-PCLogoutEvent:
-PCLoginEvent:
+OnPCDieEvent:
+OnPCKillEvent:
+OnPCLogoutEvent:
+OnPCLoginEvent:
 
 These four special labels will be invoked if you have set 'event_script_type' 
 value in your 'script_athena.conf' to 1, and you can change their names by 
@@ -2846,7 +2846,7 @@ unsigned int which loops every ~50 days.
 
 Just in case you don't know, UNIX epoch time is the number of seconds elapsed 
 since 1st of January 1970, and is useful to see, for example, for how long the 
-character has been online with PCLoginEvent and PCLogoutEvent, which could allow 
+character has been online with OnPCLoginEvent and OnPCLogoutEvent, which could allow 
 you to make an 'online time counted for conviction only' jail script.
 
 ---------------------------------------

npc/custom/Lance/FR_HallOfFame.c

@@ -33,7 +33,7 @@
 //= 2.3 - Utilizing eAthena's new scripting engine  [Lance]
 //===========================================================
 
-prontera.gat,0,0,0	script	PCLoginEvent	-1,{
+prontera.gat,0,0,0	script	OnPCLoginEvent	-1,{
 	callfunc "HallOfFameInit";
 	end;
 

npc/sample/PCLoginEvent.txt

@@ -7,7 +7,7 @@
 // if the script is like this:
 //
 // [code]
-// prontera.gat,0,0,0	script	PCLoginEvent	-1,{
+// prontera.gat,0,0,0	script	OnPCLoginEvent	-1,{
 //	mes "lmao";
 //	close;
 // }
@@ -31,7 +31,7 @@
 //
 // The 1st type -- with 'event_script_type' set to 0
 //
-prontera.gat,0,0,0	script	PCLoginEvent	-1,{
+prontera.gat,0,0,0	script	OnPCLoginEvent	-1,{
 	end;
 }
 
@@ -40,14 +40,14 @@ prontera.gat,0,0,0	script	PCLoginEvent	-1,{
 //
 prontera.gat,155,175,0	script	An NPC	46,{
 	close;
-PCLoginEvent:
+OnPCLoginEvent:
 	// this part will run
 	close;
 }
 
 prontera.gat,156,176,0	script	Another NPC	46,{
 	close;
-PCLoginEvent:
+OnPCLoginEvent:
 	// this part runs AS WELL
 	close;
 }