LuaAPI: Update siClanHealth help
authorWuzzy
Thu, 15 Mar 2018 14:23:08 +0000
changeset 1265 06c10a954ff2
parent 1264 28d3bf0701a5
child 1266 427e63ea7539
LuaAPI: Update siClanHealth help
LuaAPI.wiki
--- a/LuaAPI.wiki	Wed Mar 14 16:25:32 2018 +0000
+++ b/LuaAPI.wiki	Thu Mar 15 14:23:08 2018 +0000
@@ -1361,12 +1361,12 @@
 || `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. 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 ||
+|| `siClanHealth` || Value of a data point. This sets a single data point on the graph for the specified team. All teams will be converted to clans prior to drawing, there can only be one chart per clan. Subsequent calls will draw the next point along the horizontal axis; the frontend will then simply connect the dots in the final chart. Only whole numbers are supported. There must be at least 2 data points for any given clan, otherwise there won't be much to look at. ;-) You also should have called `SendHealthStatsOff` if 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 ||
 || `siMaxTeamDamage` || Hedgehog with most damage inflicted to his own team. `statText` must be in the format “`<damage> <hedgehog name>`”. || No ||
 || `siKilledHHs` || Total number of killed hedgehogs (converted to string). || No ||
 || `siTeamStats` || Sets the ranking of each team. Use number 0 for default ranking. Format: “`<team name 1>:<rank 1>:<team name 2>:<rank 2>:`” (and so on) || No ||
-|| `siMaxStepDamage` || Best shot award (most damage in one turn). `statText` must be in format “`<damage> <hedgehog name> (<team name>)`”. || No ||
+|| `siMaxStepDamage` || Most damage in one turn for the “best shot award”. `statText` must be in format “`<damage> <hedgehog name> (<team name>)`”. || No ||
 || `siMaxTurnSkips` || Team with most skips. `statText` must be of format “`<number> <teamName>`”. || No ||