From e4c31445089a4948631827bd9dc8fa57344bfdeb Mon Sep 17 00:00:00 2001 From: vallode <18506096+vallode@users.noreply.github.com> Date: Mon, 13 Nov 2023 08:16:50 +0100 Subject: [PATCH] Include range information for month/day docs --- docs/dev/Lua API.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/dev/Lua API.rst b/docs/dev/Lua API.rst index 9ccd0c007..b6e20e3fd 100644 --- a/docs/dev/Lua API.rst +++ b/docs/dev/Lua API.rst @@ -1802,15 +1802,15 @@ World module * ``dfhack.world.ReadCurrentTick()`` - Returns the current game tick. + Returns the number of game ticks (``df.global.world.frame_counter``) since the start of the current game year. * ``dfhack.world.ReadCurrentMonth()`` - Returns the current game month. + Returns the current game month, ranging from 0-11 (The Dwarven year has 12 months). * ``dfhack.world.ReadCurrentDay()`` - Returns the current game day. + Returns the current game day, ranging from 1-28 (Each Dwarven month as 28 days) * ``dfhack.world.ReadCurrentWeather()``