forked from Apancore.Studio/simple-makes-complex
Formspec: create our api. Part 1
This commit is contained in:
@@ -24,6 +24,7 @@ local Formspec = {}
|
|||||||
---@field allowClose? boolean
|
---@field allowClose? boolean
|
||||||
|
|
||||||
---@param def FormspecDef?
|
---@param def FormspecDef?
|
||||||
|
---@return Formspec
|
||||||
function Formspec:new(def)
|
function Formspec:new(def)
|
||||||
if def == nil then
|
if def == nil then
|
||||||
local instance = setmetatable({}, {__index = self})
|
local instance = setmetatable({}, {__index = self})
|
||||||
@@ -31,7 +32,7 @@ function Formspec:new(def)
|
|||||||
return instance
|
return instance
|
||||||
end
|
end
|
||||||
|
|
||||||
local version = ('formspec_version[%s]'):format(def.version or 10)
|
local version = ('formspec_version[%s]'):format( def.version or 10) -- Formspec version 10 (5.13.0)
|
||||||
|
|
||||||
local size = ('size[%s,%s,%s]'):format(def.size.x, def.size.y, def.size.fixed_size or true)
|
local size = ('size[%s,%s,%s]'):format(def.size.x, def.size.y, def.size.fixed_size or true)
|
||||||
|
|
||||||
@@ -81,26 +82,31 @@ function Formspec:new(def)
|
|||||||
return instance
|
return instance
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO: описание
|
||||||
---@return string
|
---@return string
|
||||||
function Formspec:getParams()
|
function Formspec:getParams()
|
||||||
return self.params
|
return self.params
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO: описание
|
||||||
---@return string
|
---@return string
|
||||||
function Formspec:getElements()
|
function Formspec:getElements()
|
||||||
return self.params
|
return self.params
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO: описание
|
||||||
---@return string
|
---@return string
|
||||||
function Formspec:toString()
|
function Formspec:toString()
|
||||||
return self:getParams()..self:getElements()
|
return self:getParams()..self:getElements()
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO: описание
|
||||||
---@param element string
|
---@param element string
|
||||||
function Formspec:addElement(element)
|
function Formspec:addElement(element)
|
||||||
self.elements = self.elements..element
|
self.elements = self.elements..element
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO: описание
|
||||||
---@param x number
|
---@param x number
|
||||||
---@param y number
|
---@param y number
|
||||||
---@param container Formspec
|
---@param container Formspec
|
||||||
@@ -110,4 +116,306 @@ function Formspec:container(x, y, container)
|
|||||||
self:addElement(element)
|
self:addElement(element)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:scrollContainer(x, y, container)
|
||||||
|
--local element = ('container[%s,%s]'):format(x, y)..container:getElements()..'container_end[]'
|
||||||
|
|
||||||
|
--self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---@alias Formspec.ListDef {inventoryLocation:string, listName:string, x:number, y:number, w:number, h:number,startingItemIndex:number}
|
||||||
|
|
||||||
|
---@param inventoryLocation string
|
||||||
|
---@param listName string
|
||||||
|
---@param x number
|
||||||
|
---@param y number
|
||||||
|
---@param w number Are in inventory slots, not in coordinates.
|
||||||
|
---@param h number Are in inventory slots, not in coordinates.
|
||||||
|
---@param startingItemIndex number?
|
||||||
|
function Formspec:list(inventoryLocation, listName, x, y, w, h,startingItemIndex)
|
||||||
|
if startingItemIndex == nil then
|
||||||
|
startingItemIndex = 0
|
||||||
|
end
|
||||||
|
|
||||||
|
local element = ('list[%s;%s;%s,%s;%s,%s;%s]'):format(
|
||||||
|
inventoryLocation, listName, x, y, w, h,startingItemIndex)
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO: немного отличается от листринга луанти, так что надо дописать подробности
|
||||||
|
---@param lists [string, string][]? List of looping lists in the format `[inventory location, list name]`
|
||||||
|
function Formspec:listring(lists)
|
||||||
|
if lists == nil then
|
||||||
|
self:addElement('listring[]')
|
||||||
|
end
|
||||||
|
|
||||||
|
local element = ''
|
||||||
|
|
||||||
|
for list in lists do
|
||||||
|
element = element..('listring[%s;%s]'):format(list[1], list[2])
|
||||||
|
end
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---The following descriptions are allowed:
|
||||||
|
--- * `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
|
||||||
|
--- * `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
|
||||||
|
--- * `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
|
||||||
|
---@param slotBackgroundNormal ColorString
|
||||||
|
---@param slotBackgroundHover ColorString
|
||||||
|
---@param slotBorder ColorString?
|
||||||
|
---@param tooltipBgcolor ColorString?
|
||||||
|
---@param tooltipFontcolor ColorString?
|
||||||
|
function Formspec:listColors(slotBackgroundNormal, slotBackgroundHover, slotBorder, tooltipBgcolor, tooltipFontcolor)
|
||||||
|
local element
|
||||||
|
|
||||||
|
if tooltipBgcolor ~= nil and tooltipFontcolor ~= nil then
|
||||||
|
element = ('listcolors[%s;%s;%s;%s;%s]'):format(
|
||||||
|
slotBackgroundNormal, slotBackgroundHover, slotBorder, tooltipBgcolor, tooltipFontcolor)
|
||||||
|
elseif slotBorder ~= nil then
|
||||||
|
element = ('listcolors[%s;%s;%s]'):format(
|
||||||
|
slotBackgroundNormal, slotBackgroundHover, slotBorder)
|
||||||
|
else
|
||||||
|
element = ('listcolors[%s;%s]'):format(
|
||||||
|
slotBackgroundNormal, slotBackgroundHover)
|
||||||
|
end
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---Adds tooltip for an element.
|
||||||
|
---@param elementName string
|
||||||
|
---@param tooltipText string
|
||||||
|
---@param bgcolor ColorString?
|
||||||
|
---@param fontcolor ColorString?
|
||||||
|
function Formspec:tooltipForElement(elementName, tooltipText, bgcolor, fontcolor)
|
||||||
|
local element = ('tooltip[%s;%s;%s;%s]'):format(
|
||||||
|
elementName, tooltipText, bgcolor or '', fontcolor or '')
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---Adds tooltip for an area. Other tooltips will take priority when present.
|
||||||
|
---@param x number
|
||||||
|
---@param y number
|
||||||
|
---@param w number
|
||||||
|
---@param h number
|
||||||
|
---@param tooltipText string
|
||||||
|
---@param bgcolor ColorString?
|
||||||
|
---@param fontcolor ColorString?
|
||||||
|
function Formspec:tooltipForArea(x, y, w, h, tooltipText, bgcolor, fontcolor)
|
||||||
|
local element = ('tooltip[%s,%s;%s,%s;%s;%s;%s]'):format(
|
||||||
|
x, y, w, h, tooltipText, bgcolor or '', fontcolor or '')
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---Show an image.
|
||||||
|
---@param x number
|
||||||
|
---@param y number
|
||||||
|
---@param w number
|
||||||
|
---@param h number
|
||||||
|
---@param textureName string
|
||||||
|
---@param middle boolean? Makes the image render in 9-sliced mode and defines the middle rect.
|
||||||
|
function Formspec:image(x, y, w, h, textureName, middle)
|
||||||
|
local element = ('image[%s,%s;%s,%s;%s;%s]'):format(
|
||||||
|
x, y, w, h, textureName, middle or '')
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---Show an animated image. The image is drawn like a "vertical_frames" tile animation
|
||||||
|
---(See Tile animation definition), but uses a frame count/duration for simplicity.
|
||||||
|
---@param x number
|
||||||
|
---@param y number
|
||||||
|
---@param w number
|
||||||
|
---@param h number
|
||||||
|
---@param textureName string
|
||||||
|
---@param frameCount number
|
||||||
|
---@param frameDuration number
|
||||||
|
---@param frameStart number
|
||||||
|
---@param middle boolean? Makes the image render in 9-sliced mode and defines the middle rect.
|
||||||
|
function Formspec:animatedImage(x, y, w, h, textureName, frameCount, frameDuration, frameStart, middle)
|
||||||
|
if middle == nil then
|
||||||
|
middle = false
|
||||||
|
end
|
||||||
|
|
||||||
|
local element = ('animated_image[%s,%s;%s,%s;%s;%s;%s;%s;%s;%s]'):format(
|
||||||
|
x, y, w, h, textureName, frameCount, frameDuration, frameStart, middle)
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---Show a mesh model.
|
||||||
|
---TODO
|
||||||
|
function Formspec:model()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---Show an inventory image of registered item/node.
|
||||||
|
---@param x number
|
||||||
|
---@param y number
|
||||||
|
---@param w number
|
||||||
|
---@param h number
|
||||||
|
---@param itemName string
|
||||||
|
function Formspec:itemImage(x, y, w, h, itemName)
|
||||||
|
local element = ('item_image[%s,%s;%s,%s;%s]'):format(
|
||||||
|
x, y, w, h, itemName)
|
||||||
|
|
||||||
|
self:addElement(element)
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:bgcolor()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:background()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:background9()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:pwdfield()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:field()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:fieldCloseOnEnter()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:textArea()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:label()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:hypertext()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:vertlabel()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:button()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:buttonUrl()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:imageButton()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:itemImageButton()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:buttonExit()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:buttonUrlExit()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:imageButtonExit()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:textlist()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:tabheader()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:box()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:dropdown()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:checkbox()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:scrollbar()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:scrollbarOptions()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:table()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:tableOptions()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:tablecolumns()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:style()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:style_type()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
---TODO
|
||||||
|
function Formspec:set_focus()
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
return Formspec
|
return Formspec
|
||||||
Reference in New Issue
Block a user