LuaAPI: Fix explanation of siMaxTeamDamage
authorWuzzy
Mon, 03 Sep 2018 22:06:49 +0100
changeset 1533 9faad9be6e0e
parent 1532 94030dc69d1e
child 1534 38fa37ffb915
LuaAPI: Fix explanation of siMaxTeamDamage
LuaAPI.wiki
--- a/LuaAPI.wiki	Mon Sep 03 19:08:32 2018 +0100
+++ b/LuaAPI.wiki	Mon Sep 03 22:06:49 2018 +0100
@@ -1498,7 +1498,7 @@
 || `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. 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 ||
+|| `siMaxTeamDamage` || Team with most damage inflicted to self. `statText` must be in the format “`<damage> <team 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` || Most damage in one turn for the “best shot award”. `statText` must be in format “`<damage> <hedgehog name> (<team name>)`”. || No ||
@@ -1510,32 +1510,45 @@
 <code language="lua">
 -- will automatically change the health icon to a star
 SendStat(siGraphTitle,'Custom Graph Title')
+
 SendStat(siGameResult,'Winner is Team A!')
+
 SendStat(siCustomAchievement,'This is a custom message posted in the Details section!')
+
 -- Changes the word kill to Point, call it just before sending kills/score for each hog
 -- in case you want to change the word i.e. print Point or Points
 SendStat(siPointType,'Point')
+
 -- if above function call was not used it will print 3 kills for teamName in Ranking section.
 -- if it was used it will print 3 Point for teamName in Ranking section.
 SendStat(siPlayerKills,'3',teamName)
+
 -- call siClanHealth to send the "value" of a clan that will be used for the graph creation
 -- a good idea is to call it always for every hog by using the runOnGears(function)
 -- in normal mode "value" represents clan health
 SendStat(siClanHealth, "100",teamName)
--- most hedgehogs killed in a round (hedgeHogName is who killed them)
-SendStat(siMaxStepKills, "1 hedgeHogName (teamName)")
--- hog with most damage inflicted to his own team
-SendStat(siMaxTeamDamage, "100 hedgeHogName")
+
+-- most hedgehogs killed in a round (hedgehogName is who killed them)
+SendStat(siMaxStepKills, "1 hedgehogName (teamName)")
+
+-- team with most damage inflicted to self
+SendStat(siMaxTeamDamage, "100 teamName")
+
 -- total number of killed hedgehogs
 SendStat(siKilledHHs, "1")
+
 -- ranking: sets rank of Megateam to 1 and rank of Superteam to 2
 SendStat(siTeamStats, "Megateam:1:Superteam:2:")
+
 -- best shot award
-SendStat(siMaxStepDamage, "30 hedgeHogName (teamName)")
+SendStat(siMaxStepDamage, "30 hedgehogName (teamName)")
+
 -- team with most kills of own hedgehogs
 SendStat(siMaxStepDamage, "2 teamName")
+
 -- team with most skips
 SendStat(siMaxTurnSkips, "3 teamName")
+
 </code>
 
 <b>Important:</b>