# HG changeset patch
# User Wuzzy
# Date 1546377525 0
# Node ID a1ff7cf0f55c4d2f226ac13a9c8ea2f0662a2a01
# Parent cb3ddd1c394acfcb9c8da2a0d1f04f0fe7fadc92
LuaAPI: Add a few 0.9.25 functions
diff -r cb3ddd1c394a -r a1ff7cf0f55c LuaAPI.wiki
--- a/LuaAPI.wiki Tue Jan 01 21:12:43 2019 +0000
+++ b/LuaAPI.wiki Tue Jan 01 21:18:45 2019 +0000
@@ -239,6 +239,9 @@
=== onSkipTurn() (0.9.24) ===
This function calls when a hog skips its turn.
+=== onGameResult(winningClan) (0.9.25) ===
+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 -1f.
+
=== onSuddenDeath() ===
This function is called on the start of Sudden Death.
@@ -1046,6 +1049,12 @@
==== !SetReadyTimeLeft(newReadyTimeLeft) (0.9.25) ====
Set the remaining ready time in milliseconds. This function should only be called in onNewTurn. The current remaining ready time can be read from the variable `ReadyTimeLeft`.
+==== !SetTurnTimePaused(isPaused) (0.9.25) ====
+Pauses the turn time indefinitely if `isPaused` is set to `true`, disabled the turn time pause if `isPaused` is set to `false`.
+
+==== !GetTurnTimePaused() (0.9.25) ====
+Returns `true` if the turn time is currently paused by `SetTurnTimePaused`, otherwise returns `false`.
+
==== !EndGame() ====
Makes the game end.
@@ -1417,6 +1426,12 @@
==== !GetCampaignVar(varname) ====
Returns the value of the campaign variable `varname` as a string. See also `SaveCampaignVar`.
+==== !SaveMissionVar(varname, value) (0.9.25) ====
+Stores the value `value` (a string) into the mission variable `varname` (also a string). A mission variable is like a campaign variable, but it applies for singleplayer missions only (Training/Challenge/Scenario), excluding campaign missions.
+
+==== !GetMissionVar(varname) (0.9.25) ====
+Returns the value of the mission variable `varname` as a string. See also `SaveMissionVar`.
+
== Functions affecting the GUI ==
=== !AddCaption(text) ===