CC-Tweaked/doc/stub/turtle.lua

-- SPDX-FileCopyrightText: 2020 The CC: Tweaked Developers
--
-- SPDX-License-Identifier: MPL-2.0

--[[- Craft a recipe based on the turtle's inventory.
The turtle's inventory should set up like a crafting grid. For instance, to
craft sticks, slots 1 and 5 should contain planks. _All_ other slots should be
empty, including those outside the crafting "grid".

@tparam[opt=64] number limit The maximum number of crafting steps to run.
@throws When limit is less than 1 or greater than 64.
@treturn[1] true If crafting succeeds.
@treturn[2] false If crafting fails.
@treturn string A string describing why crafting failed.
@since 1.4
]]
function craft(limit) end
License CC:T according to the REUSE specification (#1351) This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/ 2023-03-15 21:52:13 +00:00			`-- SPDX-FileCopyrightText: 2020 The CC: Tweaked Developers`
			`--`
Re-license several more files under MPL-2.0 - Several files where @MCJack123 is the exclusive contributor. He has signed over all contributions to "any OSI-approved license". Thank you! - Various the file handle classes: Looking at these again, I don't think they contain any of the original code. 2023-03-28 09:23:28 +00:00			`-- SPDX-License-Identifier: MPL-2.0`
License CC:T according to the REUSE specification (#1351) This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/ 2023-03-15 21:52:13 +00:00
"Finish" documentation for several modules - Add remaining docs for the turtle API - Add documentation for the fluid storage peripheral. - Enforce undocumented warning for most modules (only io and window remaining). "Finish" in quotes, because these are clearly a long way from perfect. I'm bad at writing docs, OK! 2021-04-03 11:44:22 +00:00			`--[[- Craft a recipe based on the turtle's inventory.`
			`The turtle's inventory should set up like a crafting grid. For instance, to`
Fix typo in turtle.craft documentation Description wrote "to craft sticks, slots should contain sticks", whereas it should say "planks" in the second part. 2021-07-11 08:03:41 +00:00			`craft sticks, slots 1 and 5 should contain planks. _All_ other slots should be`
"Finish" documentation for several modules - Add remaining docs for the turtle API - Add documentation for the fluid storage peripheral. - Enforce undocumented warning for most modules (only io and window remaining). "Finish" in quotes, because these are clearly a long way from perfect. I'm bad at writing docs, OK! 2021-04-03 11:44:22 +00:00			`empty, including those outside the crafting "grid".`

			`@tparam[opt=64] number limit The maximum number of crafting steps to run.`
			`@throws When limit is less than 1 or greater than 64.`
			`@treturn[1] true If crafting succeeds.`
			`@treturn[2] false If crafting fails.`
			`@treturn string A string describing why crafting failed.`
Add the rest of the feature introduction versions to the docs (#908) 2021-08-26 07:02:58 +00:00			`@since 1.4`
"Finish" documentation for several modules - Add remaining docs for the turtle API - Add documentation for the fluid storage peripheral. - Enforce undocumented warning for most modules (only io and window remaining). "Finish" in quotes, because these are clearly a long way from perfect. I'm bad at writing docs, OK! 2021-04-03 11:44:22 +00:00			`]]`
A small amount of Lua documentation I'd forgotten how tedious this was. I can't say any of these docs are especially good, but it's something. 2020-04-18 20:42:59 +00:00			`function craft(limit) end`