From b0394afab20eaee88abc2b42ab415090e5740418 Mon Sep 17 00:00:00 2001
From: euphyy <euphyy@54d463be-8e91-2dee-dedb-b68131a5f0ec>
Date: Sat, 1 Sep 2012 00:37:36 +0000
Subject: * Follow-up r16726, more standardization on docs. * Replaced and
added dividers in many script files with one standard divider. * Other misc.
cleaning...
git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@16727 54d463be-8e91-2dee-dedb-b68131a5f0ec
---
doc/atcommands.txt | 2 +-
doc/ea_job_system.txt | 11 +--
doc/effect_list.txt | 2 +-
doc/item_bonus.txt | 2 +-
doc/map_cache.txt | 5 +-
doc/permissions.txt | 14 ++--
doc/quest_variables.txt | 195 +++++++++++++++++++++----------------------
doc/whisper_sys.txt | 2 +-
doc/woe_time_explanation.txt | 2 +-
9 files changed, 114 insertions(+), 121 deletions(-)
(limited to 'doc')
diff --git a/doc/atcommands.txt b/doc/atcommands.txt
index d9f992abc..71aa38e23 100644
--- a/doc/atcommands.txt
+++ b/doc/atcommands.txt
@@ -5,7 +5,7 @@
//===== Current Version: =====================================
//= 20120824
//===== Description: =========================================
-//=
+//= List of available atcommands and their functions.
//===== Additional Comments: =================================
//= TODO: With such short descriptions, it's duplicated 'conf/help.txt'
//= Consider explaining commands in detail, similar to 'doc/script_commands.txt'
diff --git a/doc/ea_job_system.txt b/doc/ea_job_system.txt
index d483c5639..f29278f50 100644
--- a/doc/ea_job_system.txt
+++ b/doc/ea_job_system.txt
@@ -1,15 +1,12 @@
//===== rAthena Documentation ================================
-//= *Athena Job System
+//= eAthena Job System
//===== By: ==================================================
//= Skotlex
//===== Current Version: =====================================
-//= 0.2
+//= 20120610
//===== Description: =========================================
//= A reference description of eA's inner job system (for use
-//= on scripts through the eaclass and roclass script commands)
-//===== Additional Comments: =================================
-//= 0.1 - First release, explained as well as I could.
-//= 0.2 - Added info on third jobs. [Euphy]
+//= in scripts through the eaclass and roclass script commands).
//============================================================
Preface:
@@ -69,7 +66,7 @@ The next step is to either become a 2-1 or a 2-2 job:
Getting out the rebirth versions of a swordman:
- EAJ_SWORDMAN|EAJL_UPPER -> EAJ_SWORDMAN_HIGH
+ EAJ_SWORDMAN|EAJL_UPPER -> EAJ_SWORDMAN_HIGH
EAJ_SWORDMAN|EAJL_2_1|EAJL_UPPER -> EAJ_LORD_KNIGHT
EAJ_SWORDMAN|EAJL_2_2|EAJL_UPPER -> EAJ_PALADIN
diff --git a/doc/effect_list.txt b/doc/effect_list.txt
index b1b591a22..e7c3b973b 100644
--- a/doc/effect_list.txt
+++ b/doc/effect_list.txt
@@ -5,7 +5,7 @@
//===== Current Version: =====================================
//= 20120822
//===== Description: =========================================
-//= A list of client-side effects sorted by their ID
+//= A list of client-side effects sorted by ID.
//============================================================
The following is a compiled list of visual and sound effects which the client
diff --git a/doc/item_bonus.txt b/doc/item_bonus.txt
index 8f798db85..9e5fda2f9 100644
--- a/doc/item_bonus.txt
+++ b/doc/item_bonus.txt
@@ -6,7 +6,7 @@
//= 20110124
//===== Description: =========================================
//= List of script instructions used in item bonuses,
-//= mainly bonus/bonus2/bonus3/bonus4/bonus5 arguments
+//= mainly bonus/bonus2/bonus3/bonus4/bonus5 arguments.
//============================================================
skill i,n; Gives skill #i at level n (supports skill names)
diff --git a/doc/map_cache.txt b/doc/map_cache.txt
index d109a4f5f..c2e4ccb1d 100644
--- a/doc/map_cache.txt
+++ b/doc/map_cache.txt
@@ -3,13 +3,10 @@
//===== By: ==================================================
//= DracoRPG
//===== Current Version: =====================================
-//= 1.0
+//= 20070724
//===== Description: =========================================
//= A complete manual for rAthena's map cache generator as
//= well as a reference on the map cache format used.
-//===== Additional Comments: =================================
-//= 0.1 - Short howto for the initial builder version
-//= 1.0 - Complete manual covering the improved version
//============================================================
Preface:
diff --git a/doc/permissions.txt b/doc/permissions.txt
index 31592828b..3c936b157 100644
--- a/doc/permissions.txt
+++ b/doc/permissions.txt
@@ -5,10 +5,10 @@
//===== Current Version: =====================================
//= 20120718
//===== Description: =========================================
-//= permissions of player groups, configured in /conf/groups.conf
+//= Player group permissions, configured in /conf/groups.conf.
//============================================================
-can_trade : Ability to trade or otherwise distribute items (drop, storage, vending etc)
+can_trade : Ability to trade or otherwise distribute items (drop, storage, vending etc...).
can_party : Ability to join parties.
all_skill : Ability to use all skills.
all_equipment : Ability to equip anything (can cause client errors).
@@ -25,8 +25,8 @@ view_hpmeter : Ability to see HP bar of every player.
view_equipment : Ability to view players equipment regardless of their setting.
use_check : Ability to use client command /check (display character status).
use_changemaptype : Ability to use client command /changemaptype.
-all_commands: Ability to use ALL atcommands/charcommands.
-receive_requests: Ability to receive @requests.
-show_bossmobs: Ability to see boss mobs with @showmobs.
-disable_pvm: Ability to disable Player v.s. Monster.
-disable_pvp: Ability to disable Player v.s. Player.
+all_commands : Ability to use all atcommands and charcommands.
+receive_requests : Ability to receive @requests.
+show_bossmobs : Ability to see boss mobs with @showmobs.
+disable_pvm : Ability to disable Player vs. Monster.
+disable_pvp : Ability to disable Player vs. Player.
diff --git a/doc/quest_variables.txt b/doc/quest_variables.txt
index 27a039e37..8b9a6f3a3 100644
--- a/doc/quest_variables.txt
+++ b/doc/quest_variables.txt
@@ -1,109 +1,108 @@
//===== rAthena Documentation ================================
//= Permanent Quest Variables
//===== By: ==================================================
-//= rAthena Dev Team
+//= Lupus
//===== Current Version: =====================================
//= 20120826
//===== Description: =========================================
//= This file should help to understand and manage bit-wise
//= quest variables. You can store up to 31 boolean value into
//= a single variable.
-//===== Additional Comments: =================================
-//= Variable: MISC_QUEST
//============================================================
-Quest: Juice Maker Quest
-Info: How to make juices. This bit keeps final state of the quest.
-How to set: set MISC_QUEST, MISC_QUEST | 1;
-How to check: if (MISC_QUEST & 1) {}
-
-Quest: Tempestra Quest
-Info: Has you given a potion to Temperstra or not.
-How to set: set MISC_QUEST, MISC_QUEST | 2;
-How to check: if (MISC_QUEST & 2) {}
-
-Quest: Morgenstein Quest
-Info: How to make Mixture & Counteragent. Also subquest for Alchemist Job
- This bit keeps final state of the quest.
-How to set: set MISC_QUEST, MISC_QUEST | 4;
-How to check: if (MISC_QUEST & 4) {}
-
-Quest: Prontera Culvert Quest
-Info: Could you enter the Prontera Culvert or not.
-How to set: set MISC_QUEST, MISC_QUEST | 8;
-How to check: if (MISC_QUEST & 8) {}
-
-Quest: Edgar's Offer
-Info: Cheap ticket from Izlude to Alberta.
- This bit keeps final state of the quest.
-How to set: set MISC_QUEST, MISC_QUEST | 16;
-How to check: if (MISC_QUEST & 16) {}
-
-Quest: Piano Quest
-Info: The only way from Niflheim to Umbala.
-How to set: set MISC_QUEST, MISC_QUEST | 32;
-How to check: if (MISC_QUEST & 32) {}
-
-Quest: Bio Ethics Quest
-Info: Bio Ethics quest for homunculus skill for alchemists.
- This bit is for final part of quest (completed or not). [Evera]
-How to set: set MISC_QUEST, MISC_QUEST|64;
-How to check: if (MISC_QUEST & 64) {}
-
-Quest: DTS Warper
-Info: Not really a quest, but to show if a person has already voted.
- Cleaning up the variables -.-; [Evera]
-How to set: set MISC_QUEST, MISC_QUEST|128;
-How to check: if (MISC_QUEST & 128) {}
-
-Quest: -
-Info: -
-How to set: set MISC_QUEST, MISC_QUEST | 256;
-How to check: if (MISC_QUEST & 256) {}
-
-Quest: Cube Room
-Info: Lighthalzen. Cube Room Quest (Pass to Bio-Lab)
-How to set: set MISC_QUEST, MISC_QUEST | 512;
-How to check: if (MISC_QUEST & 512) {}
-
-Quest: Reset Skills Event
-Info: Yuno, Hypnotist Teacher
-How to set: set MISC_QUEST, MISC_QUEST | 1024;
-How to check: if (MISC_QUEST & 1024) {}
-
-Quest: Slotted Arm Guard Quest
-Info: Ninja Job Room, Boshuu
-How to set: set MISC_QUEST, MISC_QUEST | 2048;
-How to check: if (MISC_QUEST & 2048) {}
-
-Quest: Improved Arm Guard Quest
-Info: Ninja Job Room, Basshu
-How to set: set MISC_QUEST, MISC_QUEST | 4096;
-How to check: if (MISC_QUEST & 4096) {}
-
-Quest: Rachel Sanctuary Quest
-Info: Gained access to Rachel Santuary (yes/no)
-How to set: set MISC_QUEST, MISC_QUEST | 8192;
-How to check: if (MISC_QUEST & 8192) {}
-
-Quest: Message Delivery Quest
-Info: Send a message to Elly, in Niflheim from Erious.
-How to set: set MISC_QUEST, MISC_QUEST | 16384;
-How to check: if (MISC_QUEST & 16384) {}
-
-Quest: Umbala Domestic Dispute?
-Info: Reward: 1 yggdrasil leaf.
-How to set: set MISC_QUEST, MISC_QUEST | 32768;
-How to check: if (MISC_QUEST & 32768) {}
-
-Quest: Access to the Turtle Island
-Info: Reward: ~1 OCA, OVB, GB.
-How to set: set MISC_QUEST, MISC_QUEST | 65536;
-How to check: if (MISC_QUEST & 65536) {}
-
-
-//============================================================
-Quest: ?
-Info: ?
-How to set: set MISC_QUEST, MISC_QUEST | ?;
-How to check: if (MISC_QUEST & ?) {}
+Variable: MISC_QUEST
+--------------------------------------------------------------
+
+Quest: Juice Maker Quest
+Info: How to make juices. This bit keeps final state of the quest.
+How to set: set MISC_QUEST, MISC_QUEST | 1;
+How to check: if (MISC_QUEST & 1) {}
+
+Quest: Tempestra Quest
+Info: Determines if player has given a potion to Tempestra.
+How to set: set MISC_QUEST, MISC_QUEST | 2;
+How to check: if (MISC_QUEST & 2) {}
+
+Quest: Morgenstein Quest
+Info: How to make Mixture & Counteragent. This bit keeps final state of the quest.
+How to set: set MISC_QUEST, MISC_QUEST | 4;
+How to check: if (MISC_QUEST & 4) {}
+
+Quest: Prontera Culvert Quest
+Info: Determines if player can enter Prontera Culverts.
+How to set: set MISC_QUEST, MISC_QUEST | 8;
+How to check: if (MISC_QUEST & 8) {}
+
+Quest: Edgar's Offer
+Info: Cheap ticket from Izlude to Alberta. This bit keeps final state of the quest.
+How to set: set MISC_QUEST, MISC_QUEST | 16;
+How to check: if (MISC_QUEST & 16) {}
+
+Quest: Piano Quest
+Info: The only way from Niflheim to Umbala.
+How to set: set MISC_QUEST, MISC_QUEST | 32;
+How to check: if (MISC_QUEST & 32) {}
+
+Quest: Bio Ethics Quest
+Info: Quest for homunculus skill for alchemists. This bit keeps final state of the quest.
+How to set: set MISC_QUEST, MISC_QUEST|64;
+How to check: if (MISC_QUEST & 64) {}
+
+Quest: DTS Warper
+Info: Determines if player has already voted.
+How to set: set MISC_QUEST, MISC_QUEST|128;
+How to check: if (MISC_QUEST & 128) {}
+
+Quest: -
+Info: -
+How to set: set MISC_QUEST, MISC_QUEST | 256;
+How to check: if (MISC_QUEST & 256) {}
+
+Quest: Cube Room
+Info: Lighthalzen Cube Room quest (to enter Bio-Lab)
+How to set: set MISC_QUEST, MISC_QUEST | 512;
+How to check: if (MISC_QUEST & 512) {}
+
+Quest: Reset Skills Event
+Info: Yuno, Hypnotist Teacher
+How to set: set MISC_QUEST, MISC_QUEST | 1024;
+How to check: if (MISC_QUEST & 1024) {}
+
+Quest: Slotted Arm Guard Quest
+Info: Ninja Job Room, Boshuu
+How to set: set MISC_QUEST, MISC_QUEST | 2048;
+How to check: if (MISC_QUEST & 2048) {}
+
+Quest: Improved Arm Guard Quest
+Info: Ninja Job Room, Basshu
+How to set: set MISC_QUEST, MISC_QUEST | 4096;
+How to check: if (MISC_QUEST & 4096) {}
+
+Quest: Rachel Sanctuary Quest
+Info: Determines if player can access Rachel Santuary.
+How to set: set MISC_QUEST, MISC_QUEST | 8192;
+How to check: if (MISC_QUEST & 8192) {}
+
+Quest: Message Delivery Quest
+Info: Send a message to Elly, in Niflheim from Erious.
+How to set: set MISC_QUEST, MISC_QUEST | 16384;
+How to check: if (MISC_QUEST & 16384) {}
+
+Quest: Umbala Domestic Dispute?
+Info: Reward: 1 Yggdrasil Leaf.
+How to set: set MISC_QUEST, MISC_QUEST | 32768;
+How to check: if (MISC_QUEST & 32768) {}
+
+Quest: Access to the Turtle Island
+Info: Reward: ~1 OCA, OVB, GB.
+How to set: set MISC_QUEST, MISC_QUEST | 65536;
+How to check: if (MISC_QUEST & 65536) {}
+
+
+Variable: MISC_QUEST2
+--------------------------------------------------------------
+
+Quest: -
+Info: -
+How to set: set MISC_QUEST2, MISC_QUEST2 | ?;
+How to check: if (MISC_QUEST2 & ?) {}
diff --git a/doc/whisper_sys.txt b/doc/whisper_sys.txt
index 906dad81b..bb726974b 100644
--- a/doc/whisper_sys.txt
+++ b/doc/whisper_sys.txt
@@ -1,7 +1,7 @@
//===== rAthena Documentation ================================
//= NPC Whisper System
//===== By: ==================================================
-//= rAthena Dev Team
+//= lordalfa
//===== Current Version: =====================================
//= 20120826
//===== Description: =========================================
diff --git a/doc/woe_time_explanation.txt b/doc/woe_time_explanation.txt
index fa21834ad..75dfaf09e 100644
--- a/doc/woe_time_explanation.txt
+++ b/doc/woe_time_explanation.txt
@@ -1,7 +1,7 @@
//===== rAthena Documentation ================================
//= WoE Time Explanation
//===== By: ==================================================
-//= rAthena Dev Team
+//= erKURITA
//===== Current Version: =====================================
//= 20120717
//===== Description: =========================================
--
cgit v1.2.3-70-g09d2