LuaAPI.wiki
changeset 1533 9faad9be6e0e
parent 1532 94030dc69d1e
child 1534 38fa37ffb915
equal deleted inserted replaced
1532:94030dc69d1e 1533:9faad9be6e0e
  1496 || `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 ||
  1496 || `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 ||
  1497 || `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 ||
  1497 || `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 ||
  1498 || `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 ||
  1498 || `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 ||
  1499 || `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 ||
  1499 || `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 ||
  1500 || `siMaxStepKills` || Most hedgehogs killed in a round. `statText` must be in format “`<kills> <name of killer hedgehog> (<team name of killer>)`”. || No ||
  1500 || `siMaxStepKills` || Most hedgehogs killed in a round. `statText` must be in format “`<kills> <name of killer hedgehog> (<team name of killer>)`”. || No ||
  1501 || `siMaxTeamDamage` || Hedgehog with most damage inflicted to his own team. `statText` must be in the format “`<damage> <hedgehog name>`”. || No ||
  1501 || `siMaxTeamDamage` || Team with most damage inflicted to self. `statText` must be in the format “`<damage> <team name>`”. || No ||
  1502 || `siKilledHHs` || Total number of killed hedgehogs (converted to string). || No ||
  1502 || `siKilledHHs` || Total number of killed hedgehogs (converted to string). || No ||
  1503 || `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 ||
  1503 || `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 ||
  1504 || `siMaxStepDamage` || Most damage in one turn for the “best shot award”. `statText` must be in format “`<damage> <hedgehog name> (<team name>)`”. || No ||
  1504 || `siMaxStepDamage` || Most damage in one turn for the “best shot award”. `statText` must be in format “`<damage> <hedgehog name> (<team name>)`”. || No ||
  1505 || `siMaxTurnSkips` || Team with most skips. `statText` must be of format “`<number> <teamName>`”. || No ||
  1505 || `siMaxTurnSkips` || Team with most skips. `statText` must be of format “`<number> <teamName>`”. || No ||
  1506 
  1506 
  1508 <b>Examples:</b>
  1508 <b>Examples:</b>
  1509 
  1509 
  1510 <code language="lua">
  1510 <code language="lua">
  1511 -- will automatically change the health icon to a star
  1511 -- will automatically change the health icon to a star
  1512 SendStat(siGraphTitle,'Custom Graph Title')
  1512 SendStat(siGraphTitle,'Custom Graph Title')
       
  1513 
  1513 SendStat(siGameResult,'Winner is Team A!')
  1514 SendStat(siGameResult,'Winner is Team A!')
       
  1515 
  1514 SendStat(siCustomAchievement,'This is a custom message posted in the Details section!')
  1516 SendStat(siCustomAchievement,'This is a custom message posted in the Details section!')
       
  1517 
  1515 -- Changes the word kill to Point, call it just before sending kills/score for each hog
  1518 -- Changes the word kill to Point, call it just before sending kills/score for each hog
  1516 -- in case you want to change the word i.e. print Point or Points
  1519 -- in case you want to change the word i.e. print Point or Points
  1517 SendStat(siPointType,'Point')
  1520 SendStat(siPointType,'Point')
       
  1521 
  1518 -- if above function call was not used it will print 3 kills for teamName in Ranking section.
  1522 -- if above function call was not used it will print 3 kills for teamName in Ranking section.
  1519 -- if it was used it will print 3 Point for teamName in Ranking section.
  1523 -- if it was used it will print 3 Point for teamName in Ranking section.
  1520 SendStat(siPlayerKills,'3',teamName)
  1524 SendStat(siPlayerKills,'3',teamName)
       
  1525 
  1521 -- call siClanHealth to send the "value" of a clan that will be used for the graph creation
  1526 -- call siClanHealth to send the "value" of a clan that will be used for the graph creation
  1522 -- a good idea is to call it always for every hog by using the runOnGears(function)
  1527 -- a good idea is to call it always for every hog by using the runOnGears(function)
  1523 -- in normal mode "value" represents clan health
  1528 -- in normal mode "value" represents clan health
  1524 SendStat(siClanHealth, "100",teamName)
  1529 SendStat(siClanHealth, "100",teamName)
  1525 -- most hedgehogs killed in a round (hedgeHogName is who killed them)
  1530 
  1526 SendStat(siMaxStepKills, "1 hedgeHogName (teamName)")
  1531 -- most hedgehogs killed in a round (hedgehogName is who killed them)
  1527 -- hog with most damage inflicted to his own team
  1532 SendStat(siMaxStepKills, "1 hedgehogName (teamName)")
  1528 SendStat(siMaxTeamDamage, "100 hedgeHogName")
  1533 
       
  1534 -- team with most damage inflicted to self
       
  1535 SendStat(siMaxTeamDamage, "100 teamName")
       
  1536 
  1529 -- total number of killed hedgehogs
  1537 -- total number of killed hedgehogs
  1530 SendStat(siKilledHHs, "1")
  1538 SendStat(siKilledHHs, "1")
       
  1539 
  1531 -- ranking: sets rank of Megateam to 1 and rank of Superteam to 2
  1540 -- ranking: sets rank of Megateam to 1 and rank of Superteam to 2
  1532 SendStat(siTeamStats, "Megateam:1:Superteam:2:")
  1541 SendStat(siTeamStats, "Megateam:1:Superteam:2:")
       
  1542 
  1533 -- best shot award
  1543 -- best shot award
  1534 SendStat(siMaxStepDamage, "30 hedgeHogName (teamName)")
  1544 SendStat(siMaxStepDamage, "30 hedgehogName (teamName)")
       
  1545 
  1535 -- team with most kills of own hedgehogs
  1546 -- team with most kills of own hedgehogs
  1536 SendStat(siMaxStepDamage, "2 teamName")
  1547 SendStat(siMaxStepDamage, "2 teamName")
       
  1548 
  1537 -- team with most skips
  1549 -- team with most skips
  1538 SendStat(siMaxTurnSkips, "3 teamName")
  1550 SendStat(siMaxTurnSkips, "3 teamName")
       
  1551 
  1539 </code>
  1552 </code>
  1540 
  1553 
  1541 <b>Important:</b>
  1554 <b>Important:</b>
  1542 
  1555 
  1543   * As the game engine send stats to the frontend at the end of the game one should send her stats when the game is going to finish and right before the call of `EndGame()`. (Note: Stats are sent from the engine in `CheckForWin`. If conditions are met (win or draw) then `SendStats(uStats)` is called.)
  1556   * As the game engine send stats to the frontend at the end of the game one should send her stats when the game is going to finish and right before the call of `EndGame()`. (Note: Stats are sent from the engine in `CheckForWin`. If conditions are met (win or draw) then `SendStats(uStats)` is called.)