LuaEvents: Add onHogSwitch
authorWuzzy
Fri, 21 Jun 2019 22:44:42 +0100
changeset 1921 e65b834f2dd9
parent 1920 fea4b9719045
child 1922 0e978d0457b1
LuaEvents: Add onHogSwitch
LuaEvents.wiki
--- a/LuaEvents.wiki	Fri Jun 21 22:41:51 2019 +0100
+++ b/LuaEvents.wiki	Fri Jun 21 22:44:42 2019 +0100
@@ -82,7 +82,7 @@
 === <tt>onSuddenDeath()</tt> ===
 This function is called on the start of Sudden Death.
 
-=== <tt>onGameResult(winningClan)</tt> (0.9.25) ===
+=== <tt>onGameResult(winningClan)</tt> (1.0.0) ===
 This function calls when the game ends with a winner or in a draw. If a clan wins, `winningClan` is the clan ID of the winning clan. If the game ends in a draw, `winningClan` is set to -1.
 
 === <tt>onAchievementsDeclaration()</tt> ===
@@ -93,6 +93,11 @@
 
 Note: If you want to detect when a turn was skipped, use `onSkipTurn()`. There is no guarantee that `onHogAttack(amSkip)` is called in such an event.
 
+=== <tt>onHogSwitch(oldHog)</tt> (1.0.0) ===
+Called when hogs have been switched using the “switch hedgehog” utility. `oldHog` is the gear ID of the previous hedgehog and the current hedgehog gear ID is stored in `CurrentHedgehog`.
+
+Note: If you want to detect when a turn was skipped, use `onSkipTurn()`. There is no guarantee that `onHogAttack(amSkip)` is called in such an event.
+
 === <tt>onUsedAmmo(ammoType)</tt> ===
 Called after a weapon has been used completely, with `ammoType` as the used ammo type.