Browse Source

Documentation cleanup

aleos 1 year ago
parent
commit
56c69b5da7
6 changed files with 10 additions and 7 deletions
  1. 1 1
      db/import-tmpl/skill_db.yml
  2. 1 1
      db/pre-re/skill_db.yml
  3. 1 1
      db/re/skill_db.yml
  4. 1 1
      db/skill_db.yml
  5. 5 2
      doc/skill_db.txt
  6. 1 1
      doc/yaml/db/skill_db.yml

+ 1 - 1
db/import-tmpl/skill_db.yml

@@ -40,7 +40,7 @@
 #   HitRate                   Skill hit rate.
 #     Rates:                  Hit rate. (Default: 100)
 #       - Level               Skill level.
-#         Rate                Rate is a percent of hit rate added to hit rate.
+#         Rate                Rate is a percentage of the caster's hit rate added to hit rate.
 #     Skills:                 Skill flagged as a requirement (players only). (Optional)
 #   Element:                  Skill element. (Default: Neutral)
 #     - Level                 Skill level.

+ 1 - 1
db/pre-re/skill_db.yml

@@ -40,7 +40,7 @@
 #   HitRate                   Skill hit rate.
 #     Rates:                  Hit rate. (Default: 100)
 #       - Level               Skill level.
-#         Rate                Rate is a percent of hit rate added to hit rate.
+#         Rate                Rate is a percentage of the caster's hit rate added to hit rate.
 #     Skills:                 Skill flagged as a requirement (players only). (Optional)
 #   Element:                  Skill element. (Default: Neutral)
 #     - Level                 Skill level.

+ 1 - 1
db/re/skill_db.yml

@@ -40,7 +40,7 @@
 #   HitRate                   Skill hit rate.
 #     Rates:                  Hit rate. (Default: 100)
 #       - Level               Skill level.
-#         Rate                Rate is a percent of hit rate added to hit rate.
+#         Rate                Rate is a percentage of the caster's hit rate added to hit rate.
 #     Skills:                 Skill flagged as a requirement (players only). (Optional)
 #   Element:                  Skill element. (Default: Neutral)
 #     - Level                 Skill level.

+ 1 - 1
db/skill_db.yml

@@ -40,7 +40,7 @@
 #   HitRate                   Skill hit rate.
 #     Rates:                  Hit rate. (Default: 100)
 #       - Level               Skill level.
-#         Rate                Rate is a percent of hit rate added to hit rate.
+#         Rate                Rate is a percentage of the caster's hit rate added to hit rate.
 #     Skills:                 Skill flagged as a requirement (players only). (Optional)
 #   Element:                  Skill element. (Default: Neutral)
 #     - Level                 Skill level.

+ 5 - 2
doc/skill_db.txt

@@ -159,12 +159,15 @@ Sequence Map Form
 
 HitRate: Skill hit rate.
 
-Rates - Rate is 100 by default.
+Rates - Adjust the hit rate of the skill. Rate is 100% by default.
 
 Can be defined in scalar form or sequence map form:
 Scalar Form
   HitRate:
-	Rates: 120
+    Rates: 120 # Skill HitRate is increased by 20%.
+
+  HitRate:
+    Rates: 60 # Skill HitRate is decreased by 40%.
 
 Sequence Map Form
   HitRate:

+ 1 - 1
doc/yaml/db/skill_db.yml

@@ -23,7 +23,7 @@
 #   HitRate                   Skill hit rate.
 #     Rates:                  Hit rate. (Default: 100)
 #       - Level               Skill level.
-#         Rate                Rate is a percent of hit rate added to hit rate.
+#         Rate                Rate is a percentage of the caster's hit rate added to hit rate.
 #     Skills:                 Skill flagged as a requirement (players only). (Optional)
 #   Element:                  Skill element. (Default: Neutral)
 #     - Level                 Skill level.