Add world module documentation

docs/dev/Lua API.rst

@@ -1783,6 +1783,54 @@ Items module
 
   Checks whether the item is assigned to a squad.
 
+.. _lua-world:
+
+World module
+------------
+
+* ``dfhack.world.ReadPauseState()``
+
+  Returns *true* if the game is paused.
+
+* ``dfhack.world.SetPauseState(paused)``
+
+  Sets the pause state of the game.
+
+* ``dfhack.world.ReadCurrentYear()``
+
+  Returns the current game year.
+
+* ``dfhack.world.ReadCurrentTick()``
+
+  Returns the current game tick.
+
+* ``dfhack.world.ReadCurrentMonth()``
+
+  Returns the current game month.
+
+* ``dfhack.world.ReadCurrentDay()``
+
+  Returns the current game day.
+
+* ``dfhack.world.ReadCurrentWeather()``
+
+  Returns the current game weather (`df.weather_type`).
+
+* ``dfhack.world.SetCurrentWeather(weather)``
+
+  Sets the current game weather to `weather`.
+
+* ``dfhack.world.ReadWorldFolder()``
+
+  Returns the name of the directory/folder the current saved game is under, or an empty string if no game was loaded this session.
+
+* ``dfhack.world.isFortressMode([gametype])``
+* ``dfhack.world.isAdventureMode([gametype])``
+* ``dfhack.world.isArena([gametype])``
+* ``dfhack.world.isLegends([gametype])``
+
+  Without any arguments, returns *true* if the current gametype matches. Optionally accepts a gametype id to match against.
+
 .. _lua-maps:
 
 Maps module