LuaAPI: Update TurnTimeLeft/ReadyTimeLeft
authorWuzzy
Mon, 03 Dec 2018 22:59:01 +0000
changeset 1631 50432569b972
parent 1630 ed5018237b13
child 1632 4c982152eb2e
LuaAPI: Update TurnTimeLeft/ReadyTimeLeft
LuaAPI.wiki
--- a/LuaAPI.wiki	Sun Dec 02 00:15:46 2018 +0000
+++ b/LuaAPI.wiki	Mon Dec 03 22:59:01 2018 +0000
@@ -73,7 +73,7 @@
 The following variables are made available by Hedgewars in Lua and can be used to quickly query a value. Lua scripts schould normally *not* write to these variables, only read from them.
 
 === General variables and constants ===
-Here are some unsorted variables or constants which are available in Lua. You shouldn’t write to most of them.
+Here are some unsorted variables or constants which are available in Lua. **Consider these variables to be read-only.**
 
 || *Identifier* || *Description* ||
 || `LOCALE` || Current locale identifier (e.g. “de” for German) ||
@@ -87,8 +87,8 @@
 || `WaterLine` || The y position of the water, used to determine at which position stuff drowns. Use `SetWaterLine` to change. ||
 || `ClansCount` || Number of clans, including defeated ones (a clan is a group of teams with same color) ||
 || `TeamsCount` || Number of teams, including defeated ones ||
-|| `TurnTimeLeft` || Number of game ticks (milliseconds) left until the current turn ends. You can change this variable directly. ||
-|| `ReadyTimeLeft` || Remaining ready time in millseconds, 0 if turn in progress. Can be set in onNewTurn. In other places, it should only be read, not written. ||
+|| `TurnTimeLeft` || Number of game ticks (milliseconds) left until the current turn ends. To set this value, use `SetTurnTimeLeft` ||
+|| `ReadyTimeLeft` || Remaining ready time in millseconds, 0 if turn in progress. To set this value, use `SetReadyTimeLeft` ||
 || `GameTime` || Number of total game ticks ||
 || `TotalRounds` || Number of rounds that have passed. Equals `-1` if game has not started yet or hogs are still being placed. This variable is buggy in 0.9.23 and earlier! ||
 || `CurrentHedgehog` || The hedgehog gear that is currently in play ||