From 620e60eebce2c1f35c5c9a82f6ca365b316587f5 Mon Sep 17 00:00:00 2001 From: Valaris Date: Sun, 29 Jan 2006 16:10:48 +0000 Subject: AS OF SVN REV. 5901, WE ARE NOW USING TRUNK. ALL UNTESTED BUGFIXES/FEATURES GO INTO TRUNK. IF YOU HAVE A WORKING AND TESTED BUGFIX PUT IT INTO STABLE AS WELL AS TRUNK. EVERYTHING ELSE GOES INTO TRUNK AND WILL BE MERGED INTO STABLE BY VALARIS AND WIZPUTER. -- VALARIS git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@5094 54d463be-8e91-2dee-dedb-b68131a5f0ec --- doc/script_ref.txt | 1424 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1424 insertions(+) create mode 100644 doc/script_ref.txt (limited to 'doc/script_ref.txt') diff --git a/doc/script_ref.txt b/doc/script_ref.txt new file mode 100644 index 000000000..63fea4ec6 --- /dev/null +++ b/doc/script_ref.txt @@ -0,0 +1,1424 @@ +AthenaNPCScript + +- Table of contents + 0. Introduction + 1. Definition of NPC + 2. Explanation of Script, and Fundamental Rule + 3. Imperative Sentence, Function, and Constant Label + 4. Error Message + 5. Postscript + +0. Introduction + The function and form which are contained in this text refer to npc_sample.txt contained in the newest snapshot, and are described. + The convenience of the editor which shows this text is considered, is written and etc. is written. [ a tab character ] [ arbitrary values ]. + Although it is a coordinate system, please make a lower figure reference. + The increase in ?Y + ( 0,200)--(200,200) + | | + | | + | | + | | + | | + ( 0, 0)--(200, 0)-> the increase in X + +1. Definition of NPC + if it is below an athena directory -- anywhere -- being good (if it being able to do below athena/npc) -- please create txt for the time being + The NPC describes first what is shown (a way of speaking called NPC depending on the case is unsuitable). + + * Warp point : perform movement between MAP. + ,,warp,,,, + + gatname The MAP file name on which a warp point is put is specified. Please do not forget gat. + x The horizontal coordinates on which a warp point is put are specified. + y The vertical coordinates on which a warp point is put are specified. + displayname It is a warp point discernment child. You may overlap. It uses by debugging. + dx It is the horizontal effect range of a warp point. + dy It is the vertical effect range of a warp point. Probably I do not write a circle but think that it is a region. + Example of dx and dy (- is x and y) : + 0,0 1,0 2,2 + *@*– *–*–*–*–*– *–*–*–*–*–*–*– + *–*œ*– *–*–*œ*–*– *–*–*–*–*–*–*– + *@*– *–*–*–*–*– *–*–*–*–*–*–*– + *@ *–*–*–*œ*–*–*– + *@ *–*–*–*–*–*–*– + *@ *–*–*–*–*–*–*– + *@ *–*–*–*–*–*–*– + *@ + * I hear that and it will leap if the cell of - is stepped on. + *@ + destination_gatname It is a warp place. . Even if there is gat and there is not, don't care about it. + destination_x They are warp place horizontal coordinates. + destination_y They are warp place vertical coordinates. + + Notes : + A warp point displays only that plurality is described to be at the end when located on this position. + When the coordinates of a warp place are move prohibition cells, it leaps to somewhere in the MAP. + + * Monster : manage the spawning(aka apperance in japanese.) of a monster. + ,,,,monster,,,[,] + + gatname The appearing MAP file name is specified. + x The appearing horizontal coordinates are specified. Random at 0. + y The appearing vertical coordinates are specified. Random at 0. + xs The appearing horizontal range is specified. + ys The appearing vertical range is specified. + Example of xs and ys (- is x and y) : + 0,0 2,1 + *@*œ *–*–*–*–*– + *@ *–*–*œ*–*– + *@ *–*–*–*–*– + *@ + * And a monster appears from the cell of -. + + displayname It is the display name of the appearing monster. + npcid Please refer to mob_db.txt. id of the monster made to appear is specified. + number It is the number of the maximum appearances in the MAP and the appearance range. + spawn_delay1 After appearing, if specified the amount of time in milliseconds before it re-appears. + spawn_delay2 After dying, if specified the amount of time in milliseconds before it re-appears. + event The specified event is generated. An abbreviation is possible. + + Notes: + spawn_delay1 and spawn_delay2 judge and give priority to whether it re-appears having been based the latest [ direction ] on which as a result. + + * Store : sell an item. + ,,,shop,:,:,: + + gatname The MAP file name to arrange is specified. + x The horizontal coordinates to arrange are specified. + y The vertical coordinates to arrange are specified. + direction Direction is specified. + Details of direction : + 7 0 1 + 6 2 + 5 4 3 + + displayname The display name of the store to arrange is specified. + npcid The display sprite ID of the store to arrange is specified. + item_id The item ID put on the store to arrange is specified. Please refer to item_db. + price The price of the item specified by item_id is set up. + each : is divided by a comma (,), and more than one can be specified. + example: + item_id:price,item_id2,price2 + + * Script : create NPC. + ,,,script,,,{