LuaLibraryAchievements: rename params
authorWuzzy
Tue, 17 Jul 2018 17:59:01 +0100
changeset 1488 a955f982d72a
parent 1487 1800c3c11a33
child 1489 a11478019ccf
LuaLibraryAchievements: rename params
LuaLibraryAchievements.wiki
--- a/LuaLibraryAchievements.wiki	Tue Jul 17 17:58:22 2018 +0100
+++ b/LuaLibraryAchievements.wiki	Tue Jul 17 17:59:01 2018 +0100
@@ -10,7 +10,7 @@
 
 One existing achievement in Hedgewars is “Lively Lifeguard” in the scenario “That Sinking Feeling” which is awarded for rescuing all hogs.
 
-== `awardAchievement(name, statText, capgrp)` ==
+== `awardAchievement(name, statMessage, capgrp)` ==
 Awards an achievement with name `name` to player.
 
 Currently, this only displays a caption and adds a mention in the stat screen.
@@ -18,7 +18,7 @@
 Parameters:
 
  * `name`: Name of achievement.
- * `statText`: Optional. If set as string, this text will be shown in the stats screen. If `nil`, a default text is used.
+ * `statMessage`: Optional. If set as string, this text will be shown in the stats screen. If `nil`, a default text is used.
  * `capgrp`: Optional. Caption group of `AddCaption` to be used. Default is `capgrpMessage2`. If `false`, no caption is shown.
 
 For consistent style, treat the name like a title is written in the English language. Good: “Naughty Ninja”. Bad: “naughty ninja”.