diff --git a/mods/UI/PlayerInventoryUI/src/PlayerInventoryUI.lua b/mods/UI/PlayerInventoryUI/src/PlayerInventoryUI.lua index 167ce1f..45a3336 100644 --- a/mods/UI/PlayerInventoryUI/src/PlayerInventoryUI.lua +++ b/mods/UI/PlayerInventoryUI/src/PlayerInventoryUI.lua @@ -1,13 +1,23 @@ -local MAX_NODE_TAB_DISTANCE = 20 - +local ipairs = ipairs +local assert = assert local stringMatch = string.match local tableInsert, tableRemoveValue = table.insert, table.remove_value +local coreCheckPlayerPrivs = core.check_player_privs +local coreColorize = core.colorize +local corePosToString = core.pos_to_string +local coreGetPlayerByName = core.get_player_by_name + local BaseUI, Formspec = Smc.requireBaseUI(), Smc.requireFormspec() local CraftSystem = Smc.requireCraftSystem() local require = Mod.getInfo('smc__ui__player_inventory').require +---The distance at which a player can interact with blocks that have a node-tab. +--- +---If the player moves beyond this distance, the inventory will be forcibly closed. +local MAX_NODE_TAB_DISTANCE = 20 + ---@alias PlayerInventoryUI.TabType 'left'|'right' ---@alias PlayerInventoryUI.getTabFunc fun(self:PlayerInventoryUI,playerName:string,tabType:PlayerInventoryUI.TabType):Formspec ---@alias PlayerInventoryUI.TabName 'bag_tab'|'craft_tab'|'equip_tab'|'ref_tab'|'node_tab'|'admin_list_tab' @@ -25,10 +35,10 @@ local getAdminListTab = require('PlayerInventoryUI.getAdminListTab') ---@type table local tabs = { - ['bag_tab'] = getBagTab, - ['craft_tab'] = getCraftTab, - ['equip_tab'] = getEquipTab, - ['ref_tab'] = getRefTab, + ['bag_tab'] = getBagTab, + ['craft_tab'] = getCraftTab, + ['equip_tab'] = getEquipTab, + ['ref_tab'] = getRefTab, ['admin_list_tab'] = getAdminListTab } @@ -58,19 +68,18 @@ local function getCompactForm(self, playerName) -- -- If the tab is not specified, the crafting tab will be opened by default. ---@type PlayerInventoryUI.TabName - local leftTabName = self:getContex(playerName, 'left_tab_name') or 'craft_tab' + local leftTabName = self:getContex(playerName, 'left_tab_name') or 'craft_tab' local leftTab if leftTabName == 'node_tab' then leftTab = self:getContex(playerName, 'node_tab') else - print(leftTabName) leftTab = tabs[leftTabName] end local InventoryForm = Formspec:new({ - size = {x=14, y=12.5}, - position = {x=0.5, y=0.55}, + size = { x = 14, y = 12.5 }, + position = { x = 0.5, y = 0.55 }, noPrepend = true, }) @@ -89,18 +98,18 @@ local function getCompactForm(self, playerName) -- Selection buttons for the (left) panel local leftTabs = { - { getTabTexture(leftTabName, 'craft_tab'), 'select_left_craft_tab', core.colorize('#e1b691','craft') }, - { getTabTexture(leftTabName, 'equip_tab'), 'select_left_equip_tab', core.colorize('#e1b691','equip') }, - { getTabTexture(leftTabName, 'bag_tab'), 'select_left_bag_tab', core.colorize('#e1b691','bags') }, - { getTabTexture(leftTabName, 'ref_tab'), 'select_left_ref_tab', core.colorize('#e1b691','refs') }, + { getTabTexture(leftTabName, 'craft_tab'), 'select_left_craft_tab', coreColorize('#e1b691','craft') }, + { getTabTexture(leftTabName, 'equip_tab'), 'select_left_equip_tab', coreColorize('#e1b691','equip') }, + { getTabTexture(leftTabName, 'bag_tab'), 'select_left_bag_tab', coreColorize('#e1b691','bags') }, + { getTabTexture(leftTabName, 'ref_tab'), 'select_left_ref_tab', coreColorize('#e1b691','refs') }, } if self:getContex(playerName, 'node_tab') ~= nil then - tableInsert(leftTabs, { getTabTexture(leftTabName, 'node_tab'), 'select_left_node_tab', core.colorize('#e1b691','node') }) + tableInsert(leftTabs, { getTabTexture(leftTabName, 'node_tab'), 'select_left_node_tab', coreColorize('#e1b691','node') }) end - if core.check_player_privs(playerName, 'give') then - tableInsert(leftTabs, { getTabTexture(leftTabName, 'admin_list_tab'), 'select_left_admin_list_tab', core.colorize('#e1b691','admin list') }) + if coreCheckPlayerPrivs(playerName, 'give') then + tableInsert(leftTabs, { getTabTexture(leftTabName, 'admin_list_tab'), 'select_left_admin_list_tab', coreColorize('#e1b691','admin list') }) end InventoryForm:imageButtonRow(0, 0, 2, 0.5, leftTabs) @@ -122,7 +131,7 @@ local function getFullForm(self, playerName) -- * left tab - crafting menu; -- * right tab - equipment. ---@type PlayerInventoryUI.TabName - local leftTabName = self:getContex(playerName, 'left_tab_name') or 'craft_tab' + local leftTabName = self:getContex(playerName, 'left_tab_name') or 'craft_tab' ---@type PlayerInventoryUI.TabName local rightTabName = self:getContex(playerName, 'right_tab_name') or 'equip_tab' @@ -141,8 +150,8 @@ local function getFullForm(self, playerName) end local InventoryForm = Formspec:new({ - size = {x=28, y=12.5}, - position = {x=0.5, y=0.55}, + size = { x = 28, y = 12.5 }, + position = { x = 0.5, y = 0.55 }, noPrepend = true, }) @@ -163,28 +172,28 @@ local function getFullForm(self, playerName) -- Selection buttons for the (left) panel local leftTabs = { - { getTabTexture(leftTabName, 'craft_tab'), 'select_left_craft_tab', core.colorize('#e1b691','craft') }, - { getTabTexture(leftTabName, 'equip_tab'), 'select_left_equip_tab', core.colorize('#e1b691','equip') }, - { getTabTexture(leftTabName, 'bag_tab'), 'select_left_bag_tab', core.colorize('#e1b691','bags') }, - { getTabTexture(leftTabName, 'ref_tab'), 'select_left_ref_tab', core.colorize('#e1b691','refs') } + { getTabTexture(leftTabName, 'craft_tab'), 'select_left_craft_tab', coreColorize('#e1b691','craft') }, + { getTabTexture(leftTabName, 'equip_tab'), 'select_left_equip_tab', coreColorize('#e1b691','equip') }, + { getTabTexture(leftTabName, 'bag_tab'), 'select_left_bag_tab', coreColorize('#e1b691','bags') }, + { getTabTexture(leftTabName, 'ref_tab'), 'select_left_ref_tab', coreColorize('#e1b691','refs') } } -- Selection buttons for the (right) panel local rightTabs = { - { getTabTexture(rightTabName, 'craft_tab'), 'select_right_craft_tab', core.colorize('#e1b691','craft') }, - { getTabTexture(rightTabName, 'equip_tab'), 'select_right_equip_tab', core.colorize('#e1b691','equip') }, - { getTabTexture(rightTabName, 'bag_tab'), 'select_right_bag_tab', core.colorize('#e1b691','bags') }, - { getTabTexture(rightTabName, 'ref_tab'), 'select_right_ref_tab', core.colorize('#e1b691','refs') } + { getTabTexture(rightTabName, 'craft_tab'), 'select_right_craft_tab', coreColorize('#e1b691','craft') }, + { getTabTexture(rightTabName, 'equip_tab'), 'select_right_equip_tab', coreColorize('#e1b691','equip') }, + { getTabTexture(rightTabName, 'bag_tab'), 'select_right_bag_tab', coreColorize('#e1b691','bags') }, + { getTabTexture(rightTabName, 'ref_tab'), 'select_right_ref_tab', coreColorize('#e1b691','refs') } } if self:getContex(playerName, 'node_tab') ~= nil then - tableInsert(leftTabs, { getTabTexture(leftTabName, 'node_tab'), 'select_left_node_tab', core.colorize('#e1b691','node') }) - tableInsert(rightTabs, { getTabTexture(rightTabName, 'node_tab'), 'select_right_node_tab', core.colorize('#e1b691','node') }) + tableInsert(leftTabs, { getTabTexture(leftTabName, 'node_tab'), 'select_left_node_tab', coreColorize('#e1b691','node') }) + tableInsert(rightTabs, { getTabTexture(rightTabName, 'node_tab'), 'select_right_node_tab', coreColorize('#e1b691','node') }) end - if core.check_player_privs(playerName, 'give') then - tableInsert(leftTabs, { getTabTexture(leftTabName, 'admin_list_tab'), 'select_left_admin_list_tab', core.colorize('#e1b691','admin list') }) - tableInsert(rightTabs, { getTabTexture(rightTabName, 'admin_list_tab'), 'select_right_admin_list_tab', core.colorize('#e1b691','admin list') }) + if coreCheckPlayerPrivs(playerName, 'give') then + tableInsert(leftTabs, { getTabTexture(leftTabName, 'admin_list_tab'), 'select_left_admin_list_tab', coreColorize('#e1b691','admin list') }) + tableInsert(rightTabs, { getTabTexture(rightTabName, 'admin_list_tab'), 'select_right_admin_list_tab', coreColorize('#e1b691','admin list') }) end InventoryForm:imageButtonRow(0, 0, 2, 0.5, leftTabs) @@ -201,9 +210,6 @@ end ---@param playerName string ---@return string local function getFormSpecString(self, playerName) - -- We get the selected inventory mode. - -- * `true` - compact mode - -- * `false` - full mode ---@type boolean local compactMode = self:getContex(playerName, 'compact_mode') @@ -219,14 +225,16 @@ local function getFormSpecString(self, playerName) end end +---Inventory data for the crafting tab. ---@class PlayerInventoryUI.CraftListTabData ---@field searchFieldValue string? ----@field selectedCraft string? +---@field selectedCraft string? ---@field selectedRecipeIndex integer? ----@field selectedGroup CraftSystem.CraftGroup? ----@field pageNumber integer? ----@field handler CraftSystem.BaseCraftHandler +---@field selectedGroup CraftSystem.CraftGroup? +---@field pageNumber integer? +---@field handler CraftSystem.BaseCraftHandler +---Inventory data for the admin list tab. ---@class PlayerInventoryUI.AdminListTabData ---@field selectedItem string? ---@field searchFieldValue string? @@ -246,7 +254,6 @@ end ---|'left_node_tab_craft_data' ---|'right_node_tab_craft_data' - ---@class PlayerInventoryUI : BaseUI ---@field getFormSpecString fun(self:PlayerInventoryUI,playerName:string):string ---@field showForm fun(self:PlayerInventoryUI,playerName:string):string @@ -254,6 +261,9 @@ end ---@field setContex fun(self:PlayerInventoryUI,player:string|Player,key:PlayerInventoryUI.ContexKey,value:any) local PlayerInventoryUI = BaseUI:new('', getFormSpecString, false) +---Returns a data table for the crafting tab. +--- +---**Note**: The table is returned by reference; there is no need to save it back into the context. ---@param playerName string ---@param tabType PlayerInventoryUI.TabType ---@param tabName 'craft_tab'|'node_tab' @@ -265,6 +275,7 @@ function PlayerInventoryUI:getTabCraftData(playerName, tabType, tabName) return craftListTabData end +---Save crafting tab data to context. ---@param playerName string ---@param tabType PlayerInventoryUI.TabType ---@param tabName 'craft_tab'|'node_tab' @@ -273,6 +284,9 @@ function PlayerInventoryUI:setTabCraftData(playerName, tabType, tabName, data) self:setContex(playerName, tabType..'_'..tabName..'_craft_data', data) end +---Returns a data table for the admin list tab. +--- +---**Note**: The table is returned by reference; there is no need to save it back into the context. ---@param playerName string ---@param tabType PlayerInventoryUI.TabType ---@return PlayerInventoryUI.AdminListTabData @@ -283,6 +297,7 @@ function PlayerInventoryUI:getAdminListTabData(playerName, tabType) return listTabData end +---Save cadmin list tab data to context. ---@param playerName string ---@param tabType PlayerInventoryUI.TabType ---@param data PlayerInventoryUI.AdminListTabData @@ -290,12 +305,17 @@ function PlayerInventoryUI:setAdminListTabData(playerName, tabType, data) self:setContex(playerName, tabType..'_admin_list_data', data) end +---A table containing information about which player +---opened an inventory (node_tab) and at what coordinates. +--- +---Format: `table` ---@type table PlayerInventoryUI.ActiveNodeForms = {} ----@param nodePos MapVector +---@param nodePos MapVector +---@param playerName string function PlayerInventoryUI:addActiveNodeForm(nodePos, playerName) - local stringPos = core.pos_to_string(nodePos) + local stringPos = corePosToString(nodePos) local playerNames = self.ActiveNodeForms[stringPos] if playerNames == nil then self.ActiveNodeForms[stringPos] = { playerName } @@ -306,23 +326,25 @@ end ---@param nodePos MapVector function PlayerInventoryUI:updateNodeForm(nodePos) - local stringPos = core.pos_to_string(nodePos) + local stringPos = corePosToString(nodePos) local playerNames = self.ActiveNodeForms[stringPos] if playerNames == nil then return end for _, playerName in ipairs(playerNames) do - local player = core.get_player_by_name(playerName) + local player = coreGetPlayerByName(playerName) + if player ~= nil then player:set_inventory_formspec(PlayerInventoryUI:getFormSpecString(playerName)) end end end ----@param nodePos MapVector +---@param nodePos MapVector +---@param playerName string function PlayerInventoryUI:removeActiveNodeForm(nodePos, playerName) - local stringPos = core.pos_to_string(nodePos) + local stringPos = corePosToString(nodePos) local playerNames = self.ActiveNodeForms[stringPos] if playerNames == nil then return @@ -332,11 +354,11 @@ function PlayerInventoryUI:removeActiveNodeForm(nodePos, playerName) end -- We are overriding the `BaseUI.showForm` & `BaseUI.closeForm`. -local showForm = PlayerInventoryUI.showForm +local showForm = PlayerInventoryUI.showForm local closeForm = PlayerInventoryUI.closeForm function PlayerInventoryUI:showForm(playerName) - local player = core.get_player_by_name(playerName) + local player = coreGetPlayerByName(playerName) assert(player ~= nil) -- We overwrite the player's inventory definition so that the updated inventory @@ -381,14 +403,18 @@ local function closeNodeTab(player) if rightTabName == 'node_tab' then PlayerInventoryUI:setContex(playerName, 'right_tab_name', nil) end + player:set_inventory_formspec(PlayerInventoryUI:getFormSpecString(playerName)) end -- When closing the form, we clear all data related to the node's inventory tab. PlayerInventoryUI:registerOnFormQuit(closeNodeTab) +-- If a player moves too far away from a block whose inventory they are interacting with, +-- we will forcibly close that inventory. Smc.registerGlobalStepForEachPlayer(0, function(deltaTime, player) local playerName = player:get_player_name() + if Smc.getActiveFormspec(playerName) == '' then local nodePos = PlayerInventoryUI:getContex(playerName, 'node_tab_pos') if nodePos == nil then @@ -404,6 +430,8 @@ Smc.registerGlobalStepForEachPlayer(0, function(deltaTime, player) end end) +--- Inventory action handling --- + -- Handling the press of the inventory mode change button. PlayerInventoryUI:registerOnFormFieldAction('change_compact_mode', function(player, fieldName, fieldValue) local playerName = player:get_player_name() @@ -431,7 +459,9 @@ PlayerInventoryUI:registerOnFormFieldActionMatch('select_[%a]+_%S+', function(pl PlayerInventoryUI:showForm(playerName) end) --- Hadling input in the items list search bar. +-- require('PlayerInventoryUI.actionHandling.general') + +-- Handling input in the items list search bar. PlayerInventoryUI:registerOnFormFieldActionMatch('%S+::%S+::items_list_search_field', function(player, fieldName, fieldValue) local tabType, tabName = stringMatch(fieldName, '(%S+)::(%S+)::items_list_search_field') assert(tabType == 'left' or tabType == 'right') diff --git a/mods/UI/PlayerInventoryUI/src/PlayerInventoryUI/actionHandling/general.lua b/mods/UI/PlayerInventoryUI/src/PlayerInventoryUI/actionHandling/general.lua new file mode 100644 index 0000000..317d76c --- /dev/null +++ b/mods/UI/PlayerInventoryUI/src/PlayerInventoryUI/actionHandling/general.lua @@ -0,0 +1,28 @@ +local stringMatch = string.match + +-- Handling the press of the inventory mode change button. +PlayerInventoryUI:registerOnFormFieldAction('change_compact_mode', function(player, fieldName, fieldValue) + local playerName = player:get_player_name() + + local compactMode = PlayerInventoryUI:getContex(playerName, 'compact_mode') + + -- By default, the player will be shown a compact form. + if compactMode == nil then + compactMode = true + end + + PlayerInventoryUI:setContex(playerName, 'compact_mode', (not compactMode)) + PlayerInventoryUI:showForm(playerName) +end) + +-- Handling the inventory tab selection button press. +PlayerInventoryUI:registerOnFormFieldActionMatch('select_[%a]+_%S+', function(player, fieldName, fieldValue) + local tabType, tabName = stringMatch(fieldName, 'select_([%a]+)_(%S+)') + assert(tabType == 'right' or tabType == 'left') + assert(tabName ~= nil) + + local playerName = player:get_player_name() + + PlayerInventoryUI:setContex(playerName, tabType..'_tab_name', tabName) + PlayerInventoryUI:showForm(playerName) +end)