Module:Item recipe: Difference between revisions
From Space Station 14 Wiki
(wip) |
(wip) |
||
Line 83: | Line 83: | ||
-- Returns a DIV containg {{item}}s. | -- Returns a DIV containg {{item}}s. | ||
function p.generate_recipe_skeleton(frame) | function p.generate_recipe_skeleton(frame) | ||
local method = | local args = getArgs(frame) | ||
local method = args[1] | |||
assert_value_not_nil(method, "method was not provided") | assert_value_not_nil(method, "method was not provided") | ||
local product = | local product = args[2] | ||
assert_value_not_nil(product, "product was not provided") | assert_value_not_nil(product, "product was not provided") | ||
Revision as of 17:45, 23 August 2024
Module documentation
|
---|
View or edit this documentation • (about module documentation) |
Implements {{item recipe}}.
JSON files
JSON files that are updated automatically, syncing with the upstream:
- Module:Item recipe/recipes by recipe IDs.json - contains 1 to 1 mapping of recipe IDs to recipes.
- Module:Item recipe/recipe IDs by product IDs.json - contains mapping of recipe products to recipe IDs that produce these...products. Can be 1 to 1, or 1 to many.
- Module:Item recipe/recipe IDs by method and availability.json - contains a mapping of recipe production methods (e.g. Autolathe) to → availability (condition under which a recipe is available for this production method) to → recipe IDs.
Warning
Do not make changes to the above JSON files - any changes made will be erased on next update.
JSON files that are filled manually:
- Module:Item recipe/order of materials.json - a 1 to 1 mapping of recipe materials to order at which they appear in recipes. Less number = higher order. Materials that do not have an order defined here, will appear after those that do.
- Module:Item recipe/product overrides.json - a 1 to 1 mapping of recipe products to item IDs. Not all products are the same as item IDs they "represent", so sometimes a connection needs to be established explicitly.
-- Contains utilities for working with in-game items.
-- todo: material sorting. based on alphabetical sorting? maybe at .json generation step, convert materials to an array?
local p = {} --p stands for package
local getArgs = require('Module:Arguments').getArgs
local recipes_by_recipe_method = {
lathe = mw.loadJsonData("Module:Item recipe/recipes by method/lathe.json")
}
-- A table containing item recipes, identified by recipe IDs.
-- local recipes_by_recipe_id =
-- A table containing item recipe categories, identified by recipe category IDs.
-- local recipy_categories_by_recipe_category_id = mw.loadJsonData("Module:Item recipe/recipy categories by recipe category id.json")
-- ====================
function numeric_table_length(t)
local count = 0
for _ in ipairs(t) do count = count + 1 end
return count
end
function table_length(t)
local count = 0
for _ in pairs(t) do count = count + 1 end
return count
end
function table_has_value(tab, val)
for _, value in ipairs(tab) do
if value == val then
return true
end
end
return false
end
function assert_value_not_nil(value, error_message)
if value == nil then
if error_message == nil then
error("value is nil")
else
error(error_message)
end
end
end
-- ====================
-- Searches for recipes using production method and a product.
-- Product is the item ID that results from a recipe.
-- Returns an array of recipes found.
function lookup_recipes_by_method_and_product(method, product)
assert_value_not_nil(method, "method was not provided")
assert_value_not_nil(product, "product was not provided")
if method == "lathe" then
local matching_recipes = {}
for _, recipe in ipairs(recipes_by_recipe_method.lathe) do
local recipe_result = recipe.result
-- todo err message
assert_value_not_nil(recipe_result)
if recipe_result == product then
table.insert(matching_recipes, recipe)
end
end
return matching_recipes
else
error("unknown recipe method: " .. method)
end
end
-- ====================
-- Generates an HTML element, containing recipe components used to produce given item with a given method.
-- Returns a DIV containg {{item}}s.
function p.generate_recipe_skeleton(frame)
local args = getArgs(frame)
local method = args[1]
assert_value_not_nil(method, "method was not provided")
local product = args[2]
assert_value_not_nil(product, "product was not provided")
local matching_recipes = lookup_recipes_by_method_and_product(method, product)
local matching_recipes_len = numeric_table_length(matching_recipes)
mw.logObject({ method = method, product = product })
local container_el = mw.html.create("div")
:addClass("item-recipe")
if matching_recipes_len == 0 then
return container_el
elseif matching_recipes_len == 1 then
local matching_recipe = matching_recipes[1]
assert_value_not_nil(matching_recipe.materials, "'materials' field is nil for recipe " .. matching_recipe.id)
for material, cost in pairs(matching_recipe.materials) do
container_el:node(frame:preprocess("{{item|" .. material .. "|" .. cost .. "}}"))
end
return container_el
:allDone()
else
error("failed to generate a recipe skeleton: found multiple matching recipes for given method " .. method .. " and product " .. product)
end
end
-- -- Generates a list of items needed for a recipe, along with exact amounts.
-- -- Needs a recipe ID passed as a single frame argument.
-- -- Uses {{Item}} to produce the items. Returns a div containing them.
-- function p.generate_recipe_items(frame)
-- local recipe_id = args[1]
-- assert_value_not_nil(recipe_id, "recipe ID was not provided")
-- end
return p