1
0
mirror of https://codeberg.org/tenplus1/farming.git synced 2024-12-24 17:50:20 +01:00

add api.txt and tidy code

This commit is contained in:
TenPlus1 2018-05-17 09:25:16 +01:00
parent 82104e68a7
commit 6e52f96703
2 changed files with 45 additions and 4 deletions

41
api.txt Normal file
View File

@ -0,0 +1,41 @@
Farming API
-----------
The farming API allows you to easily register plants and hoes.
`farming.register_hoe(name, hoe definition)`
* Register a new hoe, see [#hoe definition]
`farming.register_plant(name, Plant definition)`
* Register a new growing plant, see [#Plant definition]
`farming.registered_plants[name] = definition`
* Table of registered plants, indexed by plant name
### Hoe Definition
{
description = "", -- Description for tooltip
inventory_image = "unknown_item.png", -- Image to be used as wield- and inventory image
max_uses = 30, -- Uses until destroyed
material = "", -- Material for recipes
recipe = { -- Craft recipe, if material isn't used
{"air", "air", "air"},
{"", "group:stick"},
{"", "group:stick"},
}
}
### Plant definition
{
description = "", -- Description of seed item
inventory_image = "unknown_item.png", -- Image to be used as seed's wield- and inventory image
steps = 8, -- How many steps the plant has to grow, until it can be harvested
-- ^ Always provide a plant texture for each step, format: modname_plantname_i.png (i = stepnumber)
minlight = 13, -- Minimum light to grow
maxlight = default.LIGHT_MAX -- Maximum light to grow
}
Note: Any crops registered with the above function will use the new growing routines, also if crops are manually added with the {growing=1} group they will also grow.

View File

@ -7,7 +7,7 @@
farming = {}
farming.mod = "redo"
farming.version = "1.33"
farming.version = "20180506"
farming.path = minetest.get_modpath("farming")
farming.select = {
type = "fixed",
@ -22,16 +22,16 @@ function farming.is_creative(name)
end
local statistics = dofile(farming.path.."/statistics.lua")
local statistics = dofile(farming.path .. "/statistics.lua")
-- Intllib
local S = dofile(farming.path.."/intllib.lua")
local S = dofile(farming.path .. "/intllib.lua")
farming.intllib = S
-- Utility Function
local time_speed = tonumber(minetest.settings:get("time_speed")) or 72
local SECS_PER_CYCLE = (time_speed > 0 and 24 * 60 * 60 / time_speed) or 0
local SECS_PER_CYCLE = (time_speed > 0 and (24 * 60 * 60) / time_speed) or 0
local function clamp(x, min, max)
return (x < min and min) or (x > max and max) or x
end