Last Time Chaning Doc For StdLib

This commit is contained in:
Cooldude2606
2018-05-30 00:08:59 +01:00
parent 310d9599b8
commit d8bb39d661
28 changed files with 369 additions and 510 deletions

View File

@@ -1,7 +1,6 @@
--- A defines module for retrieving colors by name.
-- Extends the Factorio defines table.
-- @usage require('stdlib/defines/color')
-- @module Color
-- @module StdLib.Color
-- @alias defines.color
-- defines table is automatically required in all mod loading stages.
@@ -79,7 +78,7 @@ defines.anticolor = {
red = colors.white -- defines.color.white
}
--- Returns a lighter color of a named color.
--- Returns a lighter color of a named color
-- @table defines.lightcolor
defines.lightcolor = {
white = colors.lightgrey, -- defines.color.lightgrey
@@ -196,6 +195,7 @@ function Color.from_hex(hex, alpha)
end
--added by cooldude2606
--- Converts a color in the color table format to rgb
-- @tparam table color the color to convert
-- @treturn table the color as rgb
@@ -208,6 +208,7 @@ function Color.to_rgb(color)
end
--added by cooldude2606
--- Converts a color in the color table format to hex
-- @tparam table color the color to convert
-- @treturn string the color as hex

View File

@@ -1,6 +1,5 @@
--- The game module.
-- @module Game
-- @usage local Game = require('stdlib/game')
-- @module StdLib.Game
local Game = { --luacheck: allow defined top
VALID_FILTER = function(v)

View File

@@ -1,5 +1,5 @@
--- Extends Lua 5.2 string.
-- @module String
-- @module StdLib.String
-- @alias string
-- luacheck: globals string (Allow mutating string)

View File

@@ -1,5 +1,5 @@
--- Extends Lua 5.2 table.
-- @module Table
-- @module StdLib.Table
-- @alias table
-- luacheck: globals table (Allow mutating global table)

View File

@@ -1,8 +1,7 @@
--- A defines module for retrieving the number of ticks in 1 unit of time.
-- Extends the Factorio defines table.
-- @module Time
-- @module StdLib.Time
-- @alias defines.time
-- @usage require('stdlib/defines/time')
-- defines table is automatically required in all mod loading stages.
-- luacheck: ignore 122/defines
@@ -31,6 +30,4 @@ defines.time = {
year = YEAR, -- the number of Factorio ticks in a year (365 days)
}
--- Allows index to deines.time though the Time module
--@table Time
return setmetatable({},{__index=defines.time})