Documentation

[BuckarooBanzay]

There are already some docs in the upstream wiki, but some of the local customizations
should have documentation too:

• HV Reactor digilines
• HV Digilines cable Add docs #318
• Polyfuse Add docs #318
• Overload (cheat mitigation) Add docs #318
• Chest sort modes and inventory move buttons Add docs #318
• Chest digilines functionality
• HV Quarry (operating info and digilines functionality)
• Multimeter Add docs #318
• Machine registration API Update registration functions for technic #230
• Cable registration API Update registration functions for technic #230
• Chest registration API Update chest registration API #232
• Power tool API Cleanup deprecated metadata access for tools #233

A simple markdown documentation should suffice

[S-S-X]

Linked to 2.0 release milestone and added API changes to documentation task list.

[S-S-X]

I think it is better to keep deprecated stuff (that is still available) away from documentation, and remove if present.
If still somehow relevant like deprecated function or table moved to compat/whteveritwas.lua then include deprecation warnings using Minetest logging facilities.

If something should be removed it might be good to consider moving it to compat directory and throwing clean error(message) about situation instead of just removing said function.

(not sure if we want to do that but this also allows I_do_not _care_about_deprecation = true configuration for some stuff).

[S-S-X]

There are already some docs in the upstream wiki

This documentation is already pretty much irrelevant and becomes even less relevant all the time because so much has changed, probably just confusing:

• Whole network and switching works differently
• Registrations for tools / machines / cables are about change
• Some machines work different way and have different features
• API and especially internal working is generally very different
• Commands are different
• I am sure there's a lot more that could be added to this list

[OgelGames]

Yeah, I had a look at the wiki, and there is nothing of use there, and one page is just plain incorrect (for both versions): https://github.com/minetest-mods/technic/wiki/Chests

[mase76]

I don't get any answer, not even an event when sending commands to the chest. Can you give a small example for the count_item command?

[S-S-X]

I don't get any answer, not even an event when sending commands to the chest. Can you give a small example for the count_item command?

{
  command = "count_item",
  item = "default:dirt"
}

Here's code handling commands:

technic/technic_chests/digilines.lua

Lines 25 to 102 in b4cde13

	function technic.chests.digiline_effector(pos, _, channel, msg)
	local meta = minetest.get_meta(pos)
	local set_channel = meta:get_string("channel")
	if channel ~= set_channel then
	return
	end
	if type(msg) ~= "table" or not msg.command then
	return
	end
	local inv = meta:get_inventory()
	if msg.command == "sort" then
	technic.chests.sort_inv(inv, meta:get_int("sort_mode"))
	elseif msg.command == "is_empty" then
	local empty = inv:is_empty("main")
	digilines.receptor_send(pos, digilines.rules.default, set_channel, empty)
	elseif msg.command == "get_list" then
	local inv_table = {}
	local list = inv:get_list("main")
	if list then
	for _,stack in ipairs(list) do
	if not stack:is_empty() then
	table.insert(inv_table, stack:get_name().." "..stack:get_count())
	else
	table.insert(inv_table, "")
	end
	end
	end
	digilines.receptor_send(pos, digilines.rules.default, set_channel, inv_table)
	elseif msg.command == "get_stack" and type(msg.index) == "number" then
	local stack = inv:get_stack("main", msg.index)
	local item = stack:to_table()
	if item then
	-- item available at that slot
	local def = minetest.registered_items[stack:get_name()]
	item.groups = def and table.copy(def.groups) or {}
	digilines.receptor_send(pos, digilines.rules.default, set_channel, item)
	else
	-- nothing there, return nil
	digilines.receptor_send(pos, digilines.rules.default, set_channel, nil)
	end
	elseif msg.command == "contains_item" and (type(msg.item) == "string" or type(msg.item) == "table") then
	local contains = inv:contains_item("main", msg.item)
	digilines.receptor_send(pos, digilines.rules.default, set_channel, contains)
	elseif msg.command == "room_for_item" and (type(msg.item) == "string" or type(msg.item) == "table") then
	local room = inv:room_for_item("main", msg.item)
	digilines.receptor_send(pos, digilines.rules.default, set_channel, room)
	elseif msg.command == "count_item" and (type(msg.item) == "string" or type(msg.item) == "table") then
	local count = 0
	local list = inv:get_list("main")
	if list then
	if type(msg.item) == "string" then
	local itemstack = ItemStack(msg.item)
	msg.item = {
	name = itemstack:get_name(),
	count = itemstack:get_count(),
	wear = string.match(msg.item, "%S*:%S*%s%d%s(%d)") and itemstack:get_wear(),
	metadata = string.match(msg.item, "%S*:%S*%s%d%s%d(%s.*)") and itemstack:get_meta():get_string("")
	}
	end
	for _,stack in pairs(list) do
	if not stack:is_empty() and item_matches(msg.item, stack) then
	count = count + stack:get_count()
	end
	end
	if msg.item.count and type(msg.item.count) == "number" and msg.item.count > 1 then
	count = math.floor(count / msg.item.count)
	end
	end
	digilines.receptor_send(pos, digilines.rules.default, set_channel, count)
	end
	end