PlayerInventory & PlayerInventoryUI: rename pane -> tab. #34

This commit is contained in:
Van
2026-04-07 20:50:03 +03:00
parent b579418b9a
commit cc8f896d6e
17 changed files with 174 additions and 174 deletions

View File

@@ -4,55 +4,55 @@ local BaseUI, Formspec = Smc.requireBaseUI(), Smc.requireFormspec()
local require = Mod.getInfo('smc__ui__player_inventory').require
---@alias PlayerInventoryUI.PaneType 'left'|'right'
---@alias PlayerInventoryUI.getPaneFunc fun(self:PlayerInventoryUI,playerName:string,paneType:PlayerInventoryUI.PaneType):Formspec
---@alias PlayerInventoryUI.TabType 'left'|'right'
---@alias PlayerInventoryUI.getTabFunc fun(self:PlayerInventoryUI,playerName:string,tabType:PlayerInventoryUI.TabType):Formspec
---@alias PlayerInventoryUI.PaneName 'select_pane_menu'|'bag_pane'|'craft_pane'|'equip_pane'|'ref_pane'
---@alias PlayerInventoryUI.TabName 'select_tab_menu'|'bag_tab'|'craft_tab'|'equip_tab'|'ref_tab'
---@type PlayerInventoryUI.getPaneFunc
local getSelectPaneMenu = require('PlayerInventoryUI.getSelectPaneMenu')
---@type PlayerInventoryUI.getPaneFunc
local getBagPane = require('PlayerInventoryUI.getBagPane')
---@type PlayerInventoryUI.getPaneFunc
local getCraftPane = require('PlayerInventoryUI.getCraftPane')
---@type PlayerInventoryUI.getPaneFunc
local getEquipPane = require('PlayerInventoryUI.getEquipPane')
---@type PlayerInventoryUI.getPaneFunc
local getRefPane = require('PlayerInventoryUI.getRefPane')
---@type PlayerInventoryUI.getTabFunc
local getSelectTabMenu = require('PlayerInventoryUI.getSelectTabMenu')
---@type PlayerInventoryUI.getTabFunc
local getBagTab = require('PlayerInventoryUI.getBagTab')
---@type PlayerInventoryUI.getTabFunc
local getCraftTab = require('PlayerInventoryUI.getCraftTab')
---@type PlayerInventoryUI.getTabFunc
local getEquipTab = require('PlayerInventoryUI.getEquipTab')
---@type PlayerInventoryUI.getTabFunc
local getRefTab = require('PlayerInventoryUI.getRefTab')
---@type table<PlayerInventoryUI.PaneName, PlayerInventoryUI.getPaneFunc>
local panes = {
['select_pane_menu'] = getSelectPaneMenu,
['bag_pane'] = getBagPane,
['craft_pane'] = getCraftPane,
['equip_pane'] = getEquipPane,
['ref_pane'] = getRefPane,
---@type table<PlayerInventoryUI.TabName, PlayerInventoryUI.getTabFunc>
local tabs = {
['select_tab_menu'] = getSelectTabMenu,
['bag_tab'] = getBagTab,
['craft_tab'] = getCraftTab,
['equip_tab'] = getEquipTab,
['ref_tab'] = getRefTab,
}
---@param paneName PlayerInventoryUI.PaneName
local function getPane(paneName)
if paneName == nil then
---@type PlayerInventoryUI.PaneName
paneName = 'select_pane_menu'
---@param tabName PlayerInventoryUI.TabName
local function getTab(tabName)
if tabName == nil then
---@type PlayerInventoryUI.TabName
tabName = 'select_tab_menu'
end
local pane = panes[paneName]
assert(pane ~= nil, ('The pane with the `%s` does not exist.'):format(paneName))
local tab = tabs[tabName]
assert(tab ~= nil, ('The tab with the `%s` does not exist.'):format(tabName))
return pane
return tab
end
---@param self PlayerInventoryUI
---@param playerName string
---@return string
local function getFormSpecString(self, playerName)
---@type PlayerInventoryUI.PaneName
local leftPaneName = self:getContex(playerName, 'left_pane_name') or 'select_pane_menu'
---@type PlayerInventoryUI.PaneName
local rightPaneName = self:getContex(playerName, 'right_pane_name') or 'select_pane_menu'
---@type PlayerInventoryUI.TabName
local leftTabName = self:getContex(playerName, 'left_tab_name') or 'select_tab_menu'
---@type PlayerInventoryUI.TabName
local rightTabName = self:getContex(playerName, 'right_tab_name') or 'select_tab_menu'
local leftPaneIsBlock = self:getContex(playerName, 'left_pane_is_block')
local rightPaneIsBlock = self:getContex(playerName, 'right_pane_is_block')
local leftTabIsBlock = self:getContex(playerName, 'left_tab_is_block')
local rightTabIsBlock = self:getContex(playerName, 'right_tab_is_block')
local InventoryForm = Formspec:new({
size = {x=22, y=12},
@@ -67,29 +67,29 @@ local function getFormSpecString(self, playerName)
list('current_player', 'main', 5.5,9.25, 9,1):
list('current_player', 'main', 5.5,10.75, 9,1, 9):
background(0, 9, 22, 3, 'player_inventory_middle_background.png', false):
container(panes[leftPaneName](self, playerName, 'left'), 0, 0):
container(panes[rightPaneName](self, playerName, 'right'), 11, 0):
button(10.25, 0.25, .5, .5, 'close_left_pane', 'x'):
button(21.25, 0.25, .5, .5, 'close_right_pane', 'x')
container(tabs[leftTabName](self, playerName, 'left'), 0, 0):
container(tabs[rightTabName](self, playerName, 'right'), 11, 0):
button(10.25, 0.25, .5, .5, 'close_left_tab', 'x'):
button(21.25, 0.25, .5, .5, 'close_right_tab', 'x')
return InventoryForm:toString()
end
---@alias PlayerInventoryUI.ContexKey
--- 'left_pane_name'|
--- 'right_pane_name'|
--- 'left_pane_is_block'|
--- 'right_pane_is_block'|
--- 'left_tab_name'|
--- 'right_tab_name'|
--- 'left_tab_is_block'|
--- 'right_tab_is_block'|
---
--- 'left_pane_craft_selected_craft'|
--- 'right_pane_craft_selected_craft'|
--- 'left_pane_craft_selected_group'|
--- 'right_pane_craft_selected_group'|
--- 'left_tab_craft_selected_craft'|
--- 'right_tab_craft_selected_craft'|
--- 'left_tab_craft_selected_group'|
--- 'right_tab_craft_selected_group'|
--- 'group_image_number'|
--- 'left_pane_craft_page_number'|
--- 'right_pane_craft_page_number'|
--- 'left_pane_craft_scroll'|
--- 'right_pane_craft_scroll'
--- 'left_tab_craft_page_number'|
--- 'right_tab_craft_page_number'|
--- 'left_tab_craft_scroll'|
--- 'right_tab_craft_scroll'
---@class PlayerInventoryUI : BaseUI
---@field getFormSpecString fun(self:PlayerInventoryUI,playerName:string):string
@@ -108,78 +108,78 @@ function PlayerInventoryUI:showForm(playerName)
return showForm(self, playerName)
end
PlayerInventoryUI:registerOnFormFieldAction('close_left_pane', function(player, fieldName, fieldValue)
PlayerInventoryUI:registerOnFormFieldAction('close_left_tab', function(player, fieldName, fieldValue)
local playerName = player:get_player_name()
PlayerInventoryUI:setContex(playerName, 'left_pane_name', 'select_pane_menu')
PlayerInventoryUI:setContex(playerName, 'left_tab_name', 'select_tab_menu')
PlayerInventoryUI:showForm(playerName)
end)
PlayerInventoryUI:registerOnFormFieldActionMatch('select_left_%S+', function(player, fieldName, fieldValue)
local paneName = stringMatch(fieldName, 'select_%S+_(%S+_%S+)')
assert(paneName ~= nil)
local tabName = stringMatch(fieldName, 'select_%S+_(%S+_%S+)')
assert(tabName ~= nil)
local playerName = player:get_player_name()
PlayerInventoryUI:setContex(playerName, 'left_pane_name', paneName)
PlayerInventoryUI:setContex(playerName, 'left_tab_name', tabName)
PlayerInventoryUI:showForm(playerName)
end)
PlayerInventoryUI:registerOnFormFieldAction('close_right_pane', function(player, fieldName, fieldValue)
PlayerInventoryUI:registerOnFormFieldAction('close_right_tab', function(player, fieldName, fieldValue)
local playerName = player:get_player_name()
PlayerInventoryUI:setContex(playerName, 'right_pane_name', 'select_pane_menu')
PlayerInventoryUI:setContex(playerName, 'right_tab_name', 'select_tab_menu')
PlayerInventoryUI:showForm(playerName)
end)
PlayerInventoryUI:registerOnFormFieldActionMatch('select_right_%S+', function(player, fieldName, fieldValue)
local paneName = stringMatch(fieldName, 'select_%S+_(%S+_%S+)')
assert(paneName ~= nil)
local tabName = stringMatch(fieldName, 'select_%S+_(%S+_%S+)')
assert(tabName ~= nil)
local playerName = player:get_player_name()
PlayerInventoryUI:setContex(playerName, 'right_pane_name', paneName)
PlayerInventoryUI:setContex(playerName, 'right_tab_name', tabName)
PlayerInventoryUI:showForm(playerName)
end)
PlayerInventoryUI:registerOnFormFieldActionMatch('%S+::page_back', function(player, fieldName, fieldValue)
local paneType = stringMatch(fieldName, '(%S+)::page_back')
assert(paneType == 'left' or paneType == 'right')
local tabType = stringMatch(fieldName, '(%S+)::page_back')
assert(tabType == 'left' or tabType == 'right')
local playerName = player:get_player_name()
local pageNumber = PlayerInventoryUI:getContex(playerName, paneType..'_pane_craft_page_number') or 1
local pageNumber = PlayerInventoryUI:getContex(playerName, tabType..'_tab_craft_page_number') or 1
pageNumber = pageNumber - 1
if pageNumber <= 0 then
pageNumber = 1
end
PlayerInventoryUI:setContex(playerName, paneType..'_pane_craft_page_number', pageNumber)
PlayerInventoryUI:setContex(playerName, tabType..'_tab_craft_page_number', pageNumber)
PlayerInventoryUI:showForm(playerName)
end)
PlayerInventoryUI:registerOnFormFieldActionMatch('%S+::page_forward', function(player, fieldName, fieldValue)
local paneType = stringMatch(fieldName, '(%S+)::page_forward')
assert(paneType == 'left' or paneType == 'right')
local tabType = stringMatch(fieldName, '(%S+)::page_forward')
assert(tabType == 'left' or tabType == 'right')
local playerName = player:get_player_name()
local pageNumber = PlayerInventoryUI:getContex(playerName, paneType..'_pane_craft_page_number') or 1
local pageNumber = PlayerInventoryUI:getContex(playerName, tabType..'_tab_craft_page_number') or 1
pageNumber = pageNumber + 1
if pageNumber <= 0 then
pageNumber = 1
end
PlayerInventoryUI:setContex(playerName, paneType..'_pane_craft_page_number', pageNumber)
PlayerInventoryUI:setContex(playerName, tabType..'_tab_craft_page_number', pageNumber)
PlayerInventoryUI:showForm(playerName)
end)
PlayerInventoryUI:registerOnFormFieldActionMatch('%S+::close_group', function(player, fieldName, fieldValue)
local paneType = stringMatch(fieldName, '(%S+)::close_group')
assert(paneType == 'left' or paneType == 'right')
local tabType = stringMatch(fieldName, '(%S+)::close_group')
assert(tabType == 'left' or tabType == 'right')
local playerName = player:get_player_name()
PlayerInventoryUI:setContex(playerName, paneType..'_pane_craft_selected_group', nil)
PlayerInventoryUI:setContex(playerName, tabType..'_tab_craft_selected_group', nil)
PlayerInventoryUI:showForm(playerName)
end)

View File

@@ -1,17 +0,0 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param paneType PlayerInventoryUI.PaneType
---@return Formspec
local function getBagPane(self, playerName, paneType)
local BagPane = Formspec:new()
BagPane:
image(0, 0, 11, 9, 'player_inventory_pane_background.png'):
label(2,2, 'BAG PANE')
return BagPane
end
return getBagPane

View File

@@ -0,0 +1,17 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param tabType PlayerInventoryUI.TabType
---@return Formspec
local function getBagTab(self, playerName, tabType)
local BagTab = Formspec:new()
BagTab:
image(0, 0, 11, 9, 'player_inventory_tab_background.png'):
label(2,2, 'BAG PANE')
return BagTab
end
return getBagTab

View File

@@ -9,20 +9,20 @@ local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param paneType PlayerInventoryUI.PaneType
---@param tabType PlayerInventoryUI.TabType
---@return Formspec
local function getCraftPane(self, playerName, paneType)
if paneType ~= 'left' and paneType ~= 'right' then
error('Incorrect argument `paneType`: '..paneType)
local function getCraftTab(self, playerName, tabType)
if tabType ~= 'left' and tabType ~= 'right' then
error('Incorrect argument `tabType`: '..tabType)
end
local CraftPane = Formspec:new()
local CraftTab = Formspec:new()
---@type string
local selectedCraft = self:getContex(playerName, paneType..'_pane_craft_selected_craft') or ''
local selectedCraft = self:getContex(playerName, tabType..'_tab_craft_selected_craft') or ''
---@type CraftSystem.CraftGroup?
local selectedGroup = self:getContex(playerName, paneType..'_pane_craft_selected_group')
local pageNumber = self:getContex(playerName, paneType..'_pane_craft_page_number') or 1
local selectedGroup = self:getContex(playerName, tabType..'_tab_craft_selected_group')
local pageNumber = self:getContex(playerName, tabType..'_tab_craft_page_number') or 1
local crafts
if selectedGroup == nil then
@@ -41,14 +41,14 @@ local function getCraftPane(self, playerName, paneType)
if pageNumber > pagesMax then
pageNumber = pagesMax
self:setContex(playerName, paneType..'_pane_craft_page_number', pageNumber)
self:setContex(playerName, tabType..'_tab_craft_page_number', pageNumber)
end
local w, h = 0.0, 0.0
if selectedGroup ~= nil then
craftsListForm:
imageButton(0, 0, 1.125, 1.125, 'player_inventory_craft_pane_close_group_button_background.png', paneType..'::close_group')
imageButton(0, 0, 1.125, 1.125, 'player_inventory_craft_tab_close_group_button_background.png', tabType..'::close_group')
w = 1.125
end
@@ -66,10 +66,10 @@ local function getCraftPane(self, playerName, paneType)
if output ~= nil then
if craft.name == selectedCraft then
craftsListForm:
imageButton(w, h, 1.125, 1.125, 'player_inventory_craft_pane_button_pressed_background.png', craft.name..'::'..paneType..'::item_button')
imageButton(w, h, 1.125, 1.125, 'player_inventory_craft_tab_button_pressed_background.png', craft.name..'::'..tabType..'::item_button')
else
craftsListForm:
imageButton(w, h, 1.125, 1.125, 'player_inventory_craft_pane_button_background.png', craft.name..'::'..paneType..'::item_button')
imageButton(w, h, 1.125, 1.125, 'player_inventory_craft_tab_button_background.png', craft.name..'::'..tabType..'::item_button')
end
craftsListForm:
@@ -79,9 +79,9 @@ local function getCraftPane(self, playerName, paneType)
assert(craft ~= nil)
craftsListForm:
imageButton(w, h, 1.125, 1.125, 'player_inventory_craft_pane_button_background.png', craft.group..'::'..paneType..'::group_button'):
imageButton(w, h, 1.125, 1.125, 'player_inventory_craft_tab_button_background.png', craft.group..'::'..tabType..'::group_button'):
itemImage(w+0.0625, h+0.0625, 1, 1, craft.output):
image(w, h, 1.125, 1.125, 'player_inventory_craft_pane_group_button_overlay.png')
image(w, h, 1.125, 1.125, 'player_inventory_craft_tab_group_button_overlay.png')
end
w = w + 1.125
@@ -91,11 +91,11 @@ local function getCraftPane(self, playerName, paneType)
end
end
CraftPane:
background(0, 0, 11, 9, 'player_inventory_craft_pane_background.png'):
CraftTab:
background(0, 0, 11, 9, 'player_inventory_craft_tab_background.png'):
container(craftsListForm, 0.5, 0.5):
button(1.75, 7.75, 1, 0.5, paneType..'::page_back', '<'):
button(2.75, 7.75, 1, 0.5, paneType..'::page_forward', '>'):
button(1.75, 7.75, 1, 0.5, tabType..'::page_back', '<'):
button(2.75, 7.75, 1, 0.5, tabType..'::page_forward', '>'):
label(2.5,8.5, ('%s/%s'):format(pageNumber, pagesMax))
if selectedCraft ~= '' then
@@ -115,18 +115,18 @@ local function getCraftPane(self, playerName, paneType)
end
end
CraftPane:
CraftTab:
itemImage(5.5, 0.5, 2, 2, craft.output):
areaLabel(5.5, 3, 4, 4,
itemDef._title..'\n'..
itemDef._description..'\n\n'..
'Needed:\n'..recipe):
areaLabel(5.5, 7, 4, 1, 'Craft:'):
button(5.5, 7.5, 2, 1, paneType..'::craft_item', '1'):
button(7.5, 7.5,2, 1, paneType..'::craft_item', ''..tostring(itemDef.stack_max))
button(5.5, 7.5, 2, 1, tabType..'::craft_item', '1'):
button(7.5, 7.5,2, 1, tabType..'::craft_item', ''..tostring(itemDef.stack_max))
end
return CraftPane
return CraftTab
end
return getCraftPane
return getCraftTab

View File

@@ -1,17 +0,0 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param paneType PlayerInventoryUI.PaneType
---@return Formspec
local function getEquipPane(self, playerName, paneType)
local EquipPane = Formspec:new()
EquipPane:
image(0, 0, 11, 9, 'player_inventory_pane_background.png'):
label(2,2, 'EQUIPMENT PANE')
return EquipPane
end
return getEquipPane

View File

@@ -0,0 +1,17 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param tabType PlayerInventoryUI.TabType
---@return Formspec
local function getEquipTab(self, playerName, tabType)
local EquipTab = Formspec:new()
EquipTab:
image(0, 0, 11, 9, 'player_inventory_tab_background.png'):
label(2,2, 'EQUIPMENT PANE')
return EquipTab
end
return getEquipTab

View File

@@ -1,17 +0,0 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param paneType PlayerInventoryUI.PaneType
---@return Formspec
local function getRefPane(self, playerName, paneType)
local RefPane = Formspec:new()
RefPane:
image(0, 0, 11, 9, 'player_inventory_pane_background.png'):
label(2,2, 'REFERENCE PANE')
return RefPane
end
return getRefPane

View File

@@ -0,0 +1,17 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param tabType PlayerInventoryUI.TabType
---@return Formspec
local function getRefTab(self, playerName, tabType)
local RefTab = Formspec:new()
RefTab:
image(0, 0, 11, 9, 'player_inventory_tab_background.png'):
label(2,2, 'REFERENCE PANE')
return RefTab
end
return getRefTab

View File

@@ -1,20 +0,0 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param paneType PlayerInventoryUI.PaneType
---@return Formspec
local function getSelectPaneMenu(self, playerName, paneType)
local selectPaneMenu = Formspec:new()
selectPaneMenu:
image(0, 0, 11, 9, 'player_inventory_pane_background.png'):
button(3.5,2.5,2,2,'select_'..paneType..'_bag_pane', 'bag'):
button(5.5,2.5,2,2,'select_'..paneType..'_craft_pane', 'craft'):
button(3.5,4.5,2,2,'select_'..paneType..'_equip_pane', 'equip'):
button(5.5,4.5,2,2,'select_'..paneType..'_ref_pane', 'ref')
return selectPaneMenu
end
return getSelectPaneMenu

View File

@@ -0,0 +1,20 @@
local Formspec = Smc.requireFormspec()
---@param self PlayerInventoryUI
---@param playerName string
---@param tabType PlayerInventoryUI.TabType
---@return Formspec
local function getSelectTabMenu(self, playerName, tabType)
local selectTabMenu = Formspec:new()
selectTabMenu:
image(0, 0, 11, 9, 'player_inventory_tab_background.png'):
button(3.5,2.5,2,2,'select_'..tabType..'_bag_tab', 'bag'):
button(5.5,2.5,2,2,'select_'..tabType..'_craft_tab', 'craft'):
button(3.5,4.5,2,2,'select_'..tabType..'_equip_tab', 'equip'):
button(5.5,4.5,2,2,'select_'..tabType..'_ref_tab', 'ref')
return selectTabMenu
end
return getSelectTabMenu