Clarify siPointType usage
authorWuzzy
Sat, 28 Nov 2015 18:42:16 +0000
changeset 685 06cd9e0842e4
parent 684 5488179eb2d2
child 686 9971f0387cd3
Clarify siPointType usage
LuaAPI.wiki
--- a/LuaAPI.wiki	Tue Nov 24 20:15:39 2015 +0000
+++ b/LuaAPI.wiki	Sat Nov 28 18:42:16 2015 +0000
@@ -1129,7 +1129,7 @@
 || `siGraphTitle` || Title of the graph. If you use this, the health icon changes into a star. || No ||
 || `siGameResult` || Title of the stats screen, used to show the result of the game, i.e. who won the game || No ||
 || `siCustomAchievement` || A freeform text for a single “bullet point” in the “bullet point” list in the details section. For each time you call `SendStat` with this `TStatInfoType`, a new “bullet point” gets added to the list. || No ||
-|| `siPointType` || Replaces the word “kills” in the ranking list. Sadly, grammatical number is currently not respected at all here. || No ||
+|| `siPointType` || Replaces the word “kills” in the ranking list. You have to call this each time before you report the score or kills of a team with `siPlayerKills`. Sadly, grammatical number is currently not respected at all here. || No ||
 || `siPlayerKills` || The number of kills for the specified team (converted to a string), as shown in the ranking list. Unless the word “kills” has been replaced by `siPointType`, then that word is used instead. Only integers (converted to string) are possible. || Yes ||
 || `siClanHealth` || Value of a data point (converted to a string). This sets a single data point on the graph for the specified team. Subsequent calls will draw the next point along the horizontal axis; the frontend will then simply connect the dots in the final graph. The graphs are treated independently for each other. Currently the graph only can display positive values. You also should have called `SendHealthStatsOff` if you use this to prevent the default health graphs to be drawn. || Yes ||
 || `siMaxStepKills` || Most hedgehogs killed in a round. `statText` must be in format “`<kills> <name of killer hedgehog> (<team name of killer>)`”. || No ||