1 worldedit = worldedit or {}
6 worldedit.register_gui_function("worldedit_gui_hollow_cylinder", {
7 name = "Make Hollow Cylinder",
8 privs = {worldedit=true},
9 get_formspec = function(name) return "some formspec here" end,
10 on_select = function(name) print(name .. " clicked the button!") end,
13 Use `nil` for the `options` parameter to unregister the function associated with the given identifier.
15 Use `nil` for the `get_formspec` field to denote that the function does not have its own screen.
17 The `privs` field may not be `nil`.
19 If the identifier is already registered to another function, it will be replaced by the new one.
21 The `on_select` function must not call `worldedit.show_page`
24 worldedit.pages = {} --mapping of identifiers to options
25 local identifiers = {} --ordered list of identifiers
26 worldedit.register_gui_function = function(identifier, options)
27 if options.privs == nil or next(options.privs) == nil then
30 worldedit.pages[identifier] = options
31 table.insert(identifiers, identifier)
37 worldedit.register_gui_handler("worldedit_gui_hollow_cylinder", function(name, fields)
38 print(minetest.serialize(fields))
42 worldedit.register_gui_handler = function(identifier, handler)
44 minetest.register_on_player_receive_fields(function(player, formname, fields)
45 if not enabled then return false end
47 minetest.after(0.2, function() enabled = true end)
48 local name = player:get_player_name()
50 --ensure the player has permission to perform the action
51 local entry = worldedit.pages[identifier]
52 if entry and minetest.check_player_privs(name, entry.privs) then
53 return handler(name, fields)
59 worldedit.get_formspec_header = function(identifier)
60 local entry = worldedit.pages[identifier] or {}
61 return "button[0,0;2,0.5;worldedit_gui;Back]" ..
62 string.format("label[2,0;WorldEdit GUI > %s]", entry.name or "")
65 local get_formspec = function(name, identifier)
66 if worldedit.pages[identifier] then
67 return worldedit.pages[identifier].get_formspec(name)
69 return worldedit.pages["worldedit_gui"].get_formspec(name) --default to showing main page if an unknown page is given
72 --implement worldedit.show_page(name, page) in different ways depending on the available APIs
73 if rawget(_G, "unified_inventory") then --unified inventory installed
74 local old_func = worldedit.register_gui_function
75 worldedit.register_gui_function = function(identifier, options)
76 old_func(identifier, options)
77 unified_inventory.register_page(identifier, {get_formspec=function(player) return {formspec=options.get_formspec(player:get_player_name())} end})
80 unified_inventory.register_button("worldedit_gui", {
82 image = "inventory_plus_worldedit_gui.png",
85 minetest.register_on_player_receive_fields(function(player, formname, fields)
86 local name = player:get_player_name()
87 if fields.worldedit_gui then --main page
88 worldedit.show_page(name, "worldedit_gui")
90 elseif fields.worldedit_gui_exit then --return to original page
91 local player = minetest.get_player_by_name(name)
93 unified_inventory.set_inventory_formspec(player, "craft")
100 worldedit.show_page = function(name, page)
101 local player = minetest.get_player_by_name(name)
103 player:set_inventory_formspec(get_formspec(name, page))
106 elseif rawget(_G, "inventory_plus") then --inventory++ installed
107 minetest.register_on_joinplayer(function(player)
108 local can_worldedit = minetest.check_player_privs(player:get_player_name(), {worldedit=true})
109 if can_worldedit then
110 inventory_plus.register_button(player, "worldedit_gui", "WorldEdit")
114 --show the form when the button is pressed and hide it when done
115 local gui_player_formspecs = {}
116 minetest.register_on_player_receive_fields(function(player, formname, fields)
117 local name = player:get_player_name()
118 if fields.worldedit_gui then --main page
119 gui_player_formspecs[name] = player:get_inventory_formspec()
120 worldedit.show_page(name, "worldedit_gui")
122 elseif fields.worldedit_gui_exit then --return to original page
123 if gui_player_formspecs[name] then
124 inventory_plus.set_inventory_formspec(player, inventory_plus.get_formspec(player, "main"))
131 worldedit.show_page = function(name, page)
132 local player = minetest.get_player_by_name(name)
134 inventory_plus.set_inventory_formspec(player, get_formspec(name, page))
137 elseif rawget(_G, "smart_inventory") then -- smart_inventory installed
138 -- redefinition: Update the code element on inventory page to show the we-page
139 function worldedit.show_page(name, page)
140 local state = smart_inventory.get_page_state("worldedit_gui", name)
142 state:get("code"):set_we_formspec(page)
143 state.location.rootState:show() -- update inventory page
147 -- smart_inventory page callback. Contains just a "custom code" element
148 local function smart_worldedit_gui_callback(state)
149 local codebox = state:element("code", { name = "code", code = "" })
150 function codebox:set_we_formspec(we_page)
151 local new_formspec = get_formspec(state.location.rootState.location.player, we_page)
152 new_formspec = new_formspec:gsub('button_exit','button') --no inventory closing
153 self.data.code = "container[1,1]".. new_formspec .. "container_end[]"
155 codebox:set_we_formspec("worldedit_gui")
157 -- process input (the back button)
158 state:onInput(function(state, fields, player)
159 if fields.worldedit_gui then --main page
160 state:get("code"):set_we_formspec("worldedit_gui")
161 elseif fields.worldedit_gui_exit then --return to original page
162 state:get("code"):set_we_formspec("worldedit_gui")
163 state.location.parentState:get("crafting_button"):submit() -- switch to the crafting tab
168 -- all handler should return false to force inventory UI update
169 local orig_register_gui_handler = worldedit.register_gui_handler
170 worldedit.register_gui_handler = function(identifier, handler)
171 local wrapper = function(...)
175 orig_register_gui_handler(identifier, wrapper)
178 -- register the inventory button
179 smart_inventory.register_page({
180 name = "worldedit_gui",
181 tooltip = "Edit your World!",
182 icon = "inventory_plus_worldedit_gui.png",
183 smartfs_callback = smart_worldedit_gui_callback,
186 elseif rawget(_G, "sfinv") then --sfinv installed (part of minetest_game since 0.4.15)
187 assert(sfinv.enabled)
188 local orig_get = sfinv.pages["sfinv:crafting"].get
189 sfinv.override_page("sfinv:crafting", {
190 get = function(self, player, context)
191 local can_worldedit = minetest.check_player_privs(player, {worldedit=true})
192 local fs = orig_get(self, player, context)
193 return fs .. (can_worldedit and "image_button[0,0;1,1;inventory_plus_worldedit_gui.png;worldedit_gui;]" or "")
197 --compatibility with pre-0.4.16 sfinv
198 local set_page = sfinv.set_page or function(player, name)
199 --assumptions: src pg has no leave callback, dst pg has no enter callback
200 local ctx = {page=name}
201 sfinv.contexts[player:get_player_name()] = ctx
202 sfinv.set_player_inventory_formspec(player, ctx)
205 --show the form when the button is pressed and hide it when done
206 minetest.register_on_player_receive_fields(function(player, formname, fields)
207 if fields.worldedit_gui then --main page
208 worldedit.show_page(player:get_player_name(), "worldedit_gui")
210 elseif fields.worldedit_gui_exit then --return to original page
211 set_page(player, "sfinv:crafting")
217 worldedit.show_page = function(name, page)
218 local player = minetest.get_player_by_name(name)
220 player:set_inventory_formspec(get_formspec(name, page))
225 "worldedit_gui requires a supported \"gui management\" mod to be installed\n"..
226 "To use the GUI you need to either\n"..
227 "* Use minetest_game (at least 0.4.15) or a subgame with compatible sfinv\n"..
228 "* Install Unified Inventory or Inventory++\n"..
229 "If you do not want to use worldedit_gui, disable it by editing world.mt or from the Main Menu"
233 worldedit.register_gui_function("worldedit_gui", {
234 name = "WorldEdit GUI",
235 privs = {interact=true},
236 get_formspec = function(name)
237 --create a form with all the buttons arranged in a grid
238 local buttons, x, y, index = {}, 0, 1, 0
239 local width, height = 3, 0.8
241 for i, identifier in pairs(identifiers) do
242 if identifier ~= "worldedit_gui" then
243 local entry = worldedit.pages[identifier]
244 table.insert(buttons, string.format((entry.get_formspec and "button" or "button_exit") ..
245 "[%g,%g;%g,%g;%s;%s]", x, y, width, height, identifier, minetest.formspec_escape(entry.name)))
247 index, x = index + 1, x + width
248 if index == columns then --row is full
254 if index == 0 then --empty row
257 return string.format("size[%g,%g]", math.max(columns * width, 5), math.max(y + 0.5, 3)) ..
258 "button[0,0;2,0.5;worldedit_gui_exit;Back]" ..
259 "label[2,0;WorldEdit GUI]" ..
260 table.concat(buttons)
264 worldedit.register_gui_handler("worldedit_gui", function(name, fields)
265 for identifier, entry in pairs(worldedit.pages) do --check for WorldEdit GUI main formspec button selection
266 if fields[identifier] and identifier ~= "worldedit_gui" then
267 --ensure player has permission to perform action
268 local has_privs, missing_privs = minetest.check_player_privs(name, entry.privs)
269 if not has_privs then
270 worldedit.player_notify(name, "you are not allowed to use this function (missing privileges: " .. table.concat(missing_privs, ", ") .. ")")
273 if entry.on_select then
274 entry.on_select(name)
276 if entry.get_formspec then
277 worldedit.show_page(name, identifier)
285 dofile(minetest.get_modpath(minetest.get_current_modname()) .. "/functionality.lua")