IMGUI: Interactive components within tables fail to buffer inputs

[AndreLouisIssa]

Non-minimal example:
the plugin Testing-PerkMenu from KCD2ModLoaderPlugins works properly
but here's a temporary in-dev version that uses tables instead, which does not

Steps to reproduce:

• launch KCD2
• open the IMGUI GUI (INSERT)
• on the 'Perk Menu' window:
• attempt to toggle the checkboxes in the top table -- FAIL (on seemingly every frame)
• attempt to write text into the text entries in the top table -- FAIL (on most frames)

[AndreLouisIssa]

Full code of the temporary version that uses tables:

---@diagnostic disable: lowercase-global

local envy = rom.mods['LuaENVY-ENVY']
envy.auto()

local default_enabled_fields = { "perk_id", "perk_name", "perk_ui_name", "visibility", "exclude_in_game_mode" }

local perk_fields = { "row", "perk_id", "perk_name", "perk_ui_name", "visibility", "exclude_in_game_mode", "autolearnable", "level", "skill_selector", "ui_priority", "perk_ui_lore_desc", "icon_id", "parent_id", "metaperk_id" }

local function has_perk(soul, perk)
	return soul:HasPerk(perk_id, false)
end

local function load_perks(perk_fields)
	if rom.game == nil then return end
	-- load perk database
	local databaseName = "perk"
	rom.game.Database.LoadTable(databaseName)
	local n = rom.game.Database.GetTableInfo(databaseName).LineCount
	local database = {}
	for row = 1, n do
		local entry = rom.game.Database.GetTableLine(databaseName, row - 1)
		--print(row, entry)
		for field,value in pairs(entry) do
			--print('',field,value)
			entry[field] = tostring(value)
		end
		entry.row = tostring(row)
		database[row] = entry
	end
	return database
end

local function draw_menu()
	local perks = rawget(private, 'perks')
	if perks == nil then
		perks = load_perks()
		if perks == nil then return end
		private.perks = perks
	end
	
	local enable_fields = rawget(private, 'enable_fields')
	if enable_fields == nil then
		enable_fields = {}
		for _,field in ipairs(default_enabled_fields) do
			enable_fields[field] = true
		end
		private.enable_fields = enable_fields
	end
	
	local search_texts = rawget(private, 'search_texts')
	if search_texts == nil then
		search_texts = {}
		private.search_texts = search_texts
	end
	
	local total_fields = 0
	
	if rom.ImGui.BeginTable("Field Settings", 3) then
	
		local width = rom.ImGui.CalcTextSize("_")
	
		rom.ImGui.TableSetupColumn("Field", rom.ImGuiTableColumnFlags.WidthFixed, 25*width)
		rom.ImGui.TableSetupColumn("See", rom.ImGuiTableColumnFlags.WidthFixed, 30)
		rom.ImGui.TableSetupColumn("Search (lua pattern)")
		
		rom.ImGui.TableNextRow(rom.ImGuiTableRowFlags.Headers)
		rom.ImGui.TableNextColumn()
		rom.ImGui.Text("Field")
		rom.ImGui.TableNextColumn()
		rom.ImGui.Text("See")
		rom.ImGui.TableNextColumn()
		rom.ImGui.Text("Search (lua pattern)")
	
		for _, field in ipairs(perk_fields) do
			rom.ImGui.TableNextRow()
			rom.ImGui.TableNextColumn()
			rom.ImGui.Text(field)
			rom.ImGui.TableNextColumn()
			local active = enable_fields[field]
			if active == nil then active = false end
			active = rom.ImGui.Checkbox("##" .. field, active)
			enable_fields[field] = active
			if active then
				total_fields = total_fields + 1
			end
			rom.ImGui.TableNextColumn()
			local text = search_texts[field] or ""
			text = rom.ImGui.InputText("##" .. field, text, 128)
			search_texts[field] = text
		end
		
		rom.ImGui.EndTable()
	end
	
	rom.ImGui.Separator()
	
	local player = rom.game.player
	if player then
		local soul = player.soul
		
		local force_remove = rom.ImGui.IsKeyDown(rom.ImGuiKeyMod.Shift)
		if force_remove then
			rom.ImGui.TextColored(1, 1, 0, 1, "SHIFT is held, perks will be force removed.")
		else
			rom.ImGui.Text("Most perks can't be detected as active, hold SHIFT to force remove.")
		end
		
		if rom.ImGui.BeginTable("Found Perks", 1 + total_fields) then
		
			local width = rom.ImGui.CalcTextSize("_")
	
			rom.ImGui.TableSetupColumn("", rom.ImGuiTableColumnFlags.WidthFixed, 30)
			for _, field in ipairs(perk_fields) do
				if enable_fields[field] then
					rom.ImGui.TableSetupColumn(field)
				end
			end
			rom.ImGui.TableNextRow(rom.ImGuiTableRowFlags.Headers)
			rom.ImGui.TableNextColumn()
			for _, field in ipairs(perk_fields) do
				if enable_fields[field] then
					rom.ImGui.TableNextColumn()
					rom.ImGui.Text(field)
				end
			end
		
			for row, perk in ipairs(perks) do
				local pass = true
				for _, field in ipairs(perk_fields) do
					local text = search_texts[field]
					if #text > 0 then
						local status, result = pcall(string.find, perk[field], text)
						if not status or not result then
							pass = false
							break
						end
					end
				end
				
				if pass then
					local active = has_perk(soul, perk)
					rom.ImGui.TableNextRow()
					rom.ImGui.TableNextColumn()
					local _, clicked = rom.ImGui.Checkbox("##" .. tostring(row), active or force_remove)
					for _, field in ipairs(perk_fields) do
						if enable_fields[field] then
							rom.ImGui.TableNextColumn()
							local pf = perk[field] or ""
							local x = rom.ImGui.CalcTextSize(pf)
							if rom.ImGui.Selectable(pf .. "##" .. field .. '#' .. tostring(row), false, 0, x, 0) then
								rom.ImGui.SetClipboardText(pf)
							end
						end
					end
					if clicked then
						if active or force_remove then
							soul:RemovePerk(perk.perk_id)
						else
							soul:AddPerk(perk.perk_id)
						end
					end
				end
			end
			rom.ImGui.EndTable()
		end
	else
		rom.ImGui.TextColored(1, 0, 0, 1, "Player has not yet loaded.")
	end
end

rom.gui.add_to_menu_bar( function()
	local show_menu = rawget(private, 'show_menu')
	if show_menu == nil then show_menu = false end
	show_menu = rom.ImGui.Checkbox("Show Menu", show_menu)
	private.show_menu = show_menu
	if show_menu then draw_menu() end
end )

rom.gui.add_imgui( function()
	if rom.ImGui.Begin("Perk Menu") then
		draw_menu()
		rom.ImGui.End()
	end
end )