Doc Added

modules/FactorioStdLib/time.lua

@@ -0,0 +1,31 @@
+--- A defines module for retrieving the number of ticks in 1 unit of time.
+-- Extends the Factorio defines table.
+-- @module defines.time
+-- @usage require('stdlib/defines/time')
+
+-- defines table is automatically required in all mod loading stages.
+-- luacheck: ignore 122/defines
+-- Ignore assigning to read only defines table. defines table is not read only, however
+-- marking it this way allows warnings to be generated when trying to assign values.
+
+defines = defines or {} --luacheck: ignore defines (This is used for testing locally)
+
+local SECOND = 60
+local MINUTE = SECOND * 60
+local HOUR = MINUTE * 60
+local DAY = HOUR * 24
+local WEEK = DAY * 7
+local MONTH = DAY * 30
+local YEAR = DAY * 365
+
+--- Returns the number of ticks in a second, minute, hour, day, week, month, or year.
+-- @usage local ten_seconds = defines.time.second * 10
+defines.time = {
+    second = SECOND, -- the number of Factorio ticks in a second
+    minute = MINUTE, -- the number of Factorio ticks in a second
+    hour = HOUR, -- the number of Factorio ticks in an hour
+    day = DAY, -- the number of Factorio ticks in an day
+    week = WEEK, -- the number of Factorio ticks in a week
+    month = MONTH, -- the number of Factorio ticks in a month (30 days)
+    year = YEAR, -- the number of Factorio ticks in a year (365 days)
+}