LuaStats: Extend siPointType table
authorWuzzy
Sat, 12 Oct 2019 11:36:19 +0100
changeset 2020 823ccc573d62
parent 2019 12cc62c0ae38
child 2021 25a948f79196
LuaStats: Extend siPointType table
LuaStats.wiki
--- a/LuaStats.wiki	Fri Oct 11 21:09:28 2019 +0100
+++ b/LuaStats.wiki	Sat Oct 12 11:36:19 2019 +0100
@@ -31,20 +31,22 @@
 
 === Special values for `siPointType` (1.0.0) ===
 
-For `siPointType`, we support a few common point types. Just set `statMessage` to one of the following special values below:
+For `siPointType`, we support a few common point types. Just set `statMessage` to one of the following values below:
 
 || *Value of `statMessage`* || *Meaning* || *How it may appear in team rankings* ||
+|| _Not set_ || Number of kills (default) || Team 1 (8 kills) ||
 || `"!POINTS"` || Number of points || Team 1 (25 points) ||
 || `"!CRATES"` || Number of crates || Team 1 (25 crates) ||
 || `"!TIME"` || Number of milliseconds, shown as seconds with 3 decimal places || Team 1 (0.025 seconds) ||
 || `"!TIME0"` … `"!TIME3"` || Number of milliseconds, shown as seconds with the decimal places specified in the number (e.g. `"!TIME2"` for 2 decimal places) || Team 1 (0.02 seconds) ||
 || `"!EMPTY"` || Don't display anything besides the team name || Team 1 ||
+|| _Anything else_ || Custom text with number. Display `statMessage` after the number || Team 1 (25 stars) ||
 
-The special values will get properly localized in the frontend, like the proper translation of the numerus form and the decimal point.
+The default text is is “kill”/“kills” and is used when you didn't use `siPointType`.
 
-If you use any other value, Hedgewars will use this string literally, but there will be no proper localization of the numerus form.
+The default and the special values with the exclamation mark will get automatically localized in the frontend, like the proper translation of the numerus form and the decimal point. Do not enclose the special values in `loc()` (see [LuaLibraryLocale]).
 
-If you want to use the number of kills in the ranking list, you do not need to call `SendStat`. The number of kills is already the default.
+The custom text will not be automatically localized, so you can enclose it in `loc()`. But there's no support for the numerus form.
 
 === Examples ===