2012-04-01 11:37:41 +02:00
|
|
|
-- Minetest: builtin/misc.lua
|
|
|
|
|
2021-03-19 21:46:11 +01:00
|
|
|
local S = core.get_translator("__builtin")
|
|
|
|
|
2012-04-01 11:37:41 +02:00
|
|
|
--
|
|
|
|
-- Misc. API functions
|
|
|
|
--
|
|
|
|
|
2021-11-26 20:19:40 +01:00
|
|
|
-- @spec core.kick_player(String, String) :: Boolean
|
|
|
|
function core.kick_player(player_name, reason)
|
|
|
|
if type(reason) == "string" then
|
|
|
|
reason = "Kicked: " .. reason
|
|
|
|
else
|
|
|
|
reason = "Kicked."
|
|
|
|
end
|
|
|
|
return core.disconnect_player(player_name, reason)
|
|
|
|
end
|
|
|
|
|
2016-07-07 23:58:52 +02:00
|
|
|
function core.check_player_privs(name, ...)
|
2018-02-05 15:17:10 +01:00
|
|
|
if core.is_player(name) then
|
Add more ways to pass data to check_player_privs
The callback can now be invoked with either the player object or name as
the first parameter, and with either a table or a list of strings, like
this:
minetest.check_player_privs(player_name, { shout = true, fly = true })
minetest.check_player_privs(player_name, "shout", "fly")
minetest.check_player_privs(player, { shout = true, fly = true })
minetest.check_player_privs(player, "shout", "fly")
2015-09-03 21:28:38 +02:00
|
|
|
name = name:get_player_name()
|
2018-02-05 15:17:10 +01:00
|
|
|
elseif type(name) ~= "string" then
|
|
|
|
error("core.check_player_privs expects a player or playername as " ..
|
|
|
|
"argument.", 2)
|
Add more ways to pass data to check_player_privs
The callback can now be invoked with either the player object or name as
the first parameter, and with either a table or a list of strings, like
this:
minetest.check_player_privs(player_name, { shout = true, fly = true })
minetest.check_player_privs(player_name, "shout", "fly")
minetest.check_player_privs(player, { shout = true, fly = true })
minetest.check_player_privs(player, "shout", "fly")
2015-09-03 21:28:38 +02:00
|
|
|
end
|
2017-01-18 11:19:57 +01:00
|
|
|
|
Add more ways to pass data to check_player_privs
The callback can now be invoked with either the player object or name as
the first parameter, and with either a table or a list of strings, like
this:
minetest.check_player_privs(player_name, { shout = true, fly = true })
minetest.check_player_privs(player_name, "shout", "fly")
minetest.check_player_privs(player, { shout = true, fly = true })
minetest.check_player_privs(player, "shout", "fly")
2015-09-03 21:28:38 +02:00
|
|
|
local requested_privs = {...}
|
2014-04-28 03:02:48 +02:00
|
|
|
local player_privs = core.get_player_privs(name)
|
2012-04-01 11:37:41 +02:00
|
|
|
local missing_privileges = {}
|
2017-01-18 11:19:57 +01:00
|
|
|
|
Add more ways to pass data to check_player_privs
The callback can now be invoked with either the player object or name as
the first parameter, and with either a table or a list of strings, like
this:
minetest.check_player_privs(player_name, { shout = true, fly = true })
minetest.check_player_privs(player_name, "shout", "fly")
minetest.check_player_privs(player, { shout = true, fly = true })
minetest.check_player_privs(player, "shout", "fly")
2015-09-03 21:28:38 +02:00
|
|
|
if type(requested_privs[1]) == "table" then
|
|
|
|
-- We were provided with a table like { privA = true, privB = true }.
|
|
|
|
for priv, value in pairs(requested_privs[1]) do
|
|
|
|
if value and not player_privs[priv] then
|
2016-03-06 16:53:45 +01:00
|
|
|
missing_privileges[#missing_privileges + 1] = priv
|
Add more ways to pass data to check_player_privs
The callback can now be invoked with either the player object or name as
the first parameter, and with either a table or a list of strings, like
this:
minetest.check_player_privs(player_name, { shout = true, fly = true })
minetest.check_player_privs(player_name, "shout", "fly")
minetest.check_player_privs(player, { shout = true, fly = true })
minetest.check_player_privs(player, "shout", "fly")
2015-09-03 21:28:38 +02:00
|
|
|
end
|
|
|
|
end
|
|
|
|
else
|
|
|
|
-- Only a list, we can process it directly.
|
|
|
|
for key, priv in pairs(requested_privs) do
|
|
|
|
if not player_privs[priv] then
|
2016-03-06 16:53:45 +01:00
|
|
|
missing_privileges[#missing_privileges + 1] = priv
|
Add more ways to pass data to check_player_privs
The callback can now be invoked with either the player object or name as
the first parameter, and with either a table or a list of strings, like
this:
minetest.check_player_privs(player_name, { shout = true, fly = true })
minetest.check_player_privs(player_name, "shout", "fly")
minetest.check_player_privs(player, { shout = true, fly = true })
minetest.check_player_privs(player, "shout", "fly")
2015-09-03 21:28:38 +02:00
|
|
|
end
|
2012-04-01 11:37:41 +02:00
|
|
|
end
|
|
|
|
end
|
2017-01-18 11:19:57 +01:00
|
|
|
|
2012-04-01 11:37:41 +02:00
|
|
|
if #missing_privileges > 0 then
|
|
|
|
return false, missing_privileges
|
|
|
|
end
|
2017-01-18 11:19:57 +01:00
|
|
|
|
2012-04-01 11:37:41 +02:00
|
|
|
return true, ""
|
|
|
|
end
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2016-10-16 18:35:07 +02:00
|
|
|
function core.send_join_message(player_name)
|
2018-07-09 20:11:35 +02:00
|
|
|
if not core.is_singleplayer() then
|
2021-03-19 21:46:11 +01:00
|
|
|
core.chat_send_all("*** " .. S("@1 joined the game.", player_name))
|
2016-08-28 01:13:41 +02:00
|
|
|
end
|
2016-10-16 18:35:07 +02:00
|
|
|
end
|
2013-09-11 16:59:48 +02:00
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2016-10-16 18:35:07 +02:00
|
|
|
function core.send_leave_message(player_name, timed_out)
|
2021-03-19 21:46:11 +01:00
|
|
|
local announcement = "*** " .. S("@1 left the game.", player_name)
|
2016-08-22 20:21:48 +02:00
|
|
|
if timed_out then
|
2021-03-19 21:46:11 +01:00
|
|
|
announcement = "*** " .. S("@1 left the game (timed out).", player_name)
|
2016-08-22 20:21:48 +02:00
|
|
|
end
|
|
|
|
core.chat_send_all(announcement)
|
2016-10-16 18:35:07 +02:00
|
|
|
end
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2016-10-16 18:35:07 +02:00
|
|
|
core.register_on_joinplayer(function(player)
|
|
|
|
local player_name = player:get_player_name()
|
2019-08-06 20:30:18 +02:00
|
|
|
if not core.is_singleplayer() then
|
2018-07-01 12:31:28 +02:00
|
|
|
local status = core.get_server_status(player_name, true)
|
|
|
|
if status and status ~= "" then
|
|
|
|
core.chat_send_player(player_name, status)
|
|
|
|
end
|
|
|
|
end
|
2016-10-16 18:35:07 +02:00
|
|
|
core.send_join_message(player_name)
|
|
|
|
end)
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2016-10-16 18:35:07 +02:00
|
|
|
core.register_on_leaveplayer(function(player, timed_out)
|
|
|
|
local player_name = player:get_player_name()
|
|
|
|
core.send_leave_message(player_name, timed_out)
|
2013-09-11 16:59:48 +02:00
|
|
|
end)
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2018-02-05 15:17:10 +01:00
|
|
|
function core.is_player(player)
|
|
|
|
-- a table being a player is also supported because it quacks sufficiently
|
|
|
|
-- like a player if it has the is_player function
|
|
|
|
local t = type(player)
|
|
|
|
return (t == "userdata" or t == "table") and
|
|
|
|
type(player.is_player) == "function" and player:is_player()
|
|
|
|
end
|
|
|
|
|
|
|
|
|
2018-07-09 20:11:35 +02:00
|
|
|
function core.player_exists(name)
|
|
|
|
return core.get_auth_handler().get_auth(name) ~= nil
|
2017-01-18 11:19:57 +01:00
|
|
|
end
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2015-09-23 06:31:45 +02:00
|
|
|
-- Returns two position vectors representing a box of `radius` in each
|
|
|
|
-- direction centered around the player corresponding to `player_name`
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2015-09-23 06:31:45 +02:00
|
|
|
function core.get_player_radius_area(player_name, radius)
|
|
|
|
local player = core.get_player_by_name(player_name)
|
|
|
|
if player == nil then
|
|
|
|
return nil
|
|
|
|
end
|
|
|
|
|
2018-07-17 20:17:54 +02:00
|
|
|
local p1 = player:get_pos()
|
2015-09-23 06:31:45 +02:00
|
|
|
local p2 = p1
|
|
|
|
|
|
|
|
if radius then
|
|
|
|
p1 = vector.subtract(p1, radius)
|
|
|
|
p2 = vector.add(p2, radius)
|
|
|
|
end
|
|
|
|
|
|
|
|
return p1, p2
|
|
|
|
end
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2022-11-09 17:57:19 +01:00
|
|
|
-- To be overridden by protection mods
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2014-04-28 03:02:48 +02:00
|
|
|
function core.is_protected(pos, name)
|
2013-08-02 22:41:36 +02:00
|
|
|
return false
|
|
|
|
end
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2014-04-28 03:02:48 +02:00
|
|
|
function core.record_protection_violation(pos, name)
|
|
|
|
for _, func in pairs(core.registered_on_protection_violation) do
|
2013-08-02 22:41:36 +02:00
|
|
|
func(pos, name)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-05-26 02:11:19 +02:00
|
|
|
-- To be overridden by Creative mods
|
|
|
|
|
|
|
|
local creative_mode_cache = core.settings:get_bool("creative_mode")
|
|
|
|
function core.is_creative_enabled(name)
|
|
|
|
return creative_mode_cache
|
|
|
|
end
|
2018-01-23 19:04:58 +01:00
|
|
|
|
|
|
|
-- Checks if specified volume intersects a protected volume
|
|
|
|
|
2018-02-25 12:25:39 +01:00
|
|
|
function core.is_area_protected(minp, maxp, player_name, interval)
|
2018-01-23 19:04:58 +01:00
|
|
|
-- 'interval' is the largest allowed interval for the 3D lattice of checks.
|
|
|
|
|
|
|
|
-- Compute the optimal float step 'd' for each axis so that all corners and
|
|
|
|
-- borders are checked. 'd' will be smaller or equal to 'interval'.
|
|
|
|
-- Subtracting 1e-4 ensures that the max co-ordinate will be reached by the
|
|
|
|
-- for loop (which might otherwise not be the case due to rounding errors).
|
|
|
|
|
|
|
|
-- Default to 4
|
|
|
|
interval = interval or 4
|
|
|
|
local d = {}
|
|
|
|
|
|
|
|
for _, c in pairs({"x", "y", "z"}) do
|
2018-02-25 12:25:39 +01:00
|
|
|
if minp[c] > maxp[c] then
|
|
|
|
-- Repair positions: 'minp' > 'maxp'
|
|
|
|
local tmp = maxp[c]
|
|
|
|
maxp[c] = minp[c]
|
|
|
|
minp[c] = tmp
|
|
|
|
end
|
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
if maxp[c] > minp[c] then
|
|
|
|
d[c] = (maxp[c] - minp[c]) /
|
|
|
|
math.ceil((maxp[c] - minp[c]) / interval) - 1e-4
|
2018-02-25 12:25:39 +01:00
|
|
|
else
|
2018-01-23 19:04:58 +01:00
|
|
|
d[c] = 1 -- Any value larger than 0 to avoid division by zero
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
for zf = minp.z, maxp.z, d.z do
|
|
|
|
local z = math.floor(zf + 0.5)
|
|
|
|
for yf = minp.y, maxp.y, d.y do
|
|
|
|
local y = math.floor(yf + 0.5)
|
|
|
|
for xf = minp.x, maxp.x, d.x do
|
|
|
|
local x = math.floor(xf + 0.5)
|
2021-06-04 21:22:33 +02:00
|
|
|
local pos = vector.new(x, y, z)
|
2018-02-25 12:25:39 +01:00
|
|
|
if core.is_protected(pos, player_name) then
|
|
|
|
return pos
|
2018-01-23 19:04:58 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
return false
|
|
|
|
end
|
|
|
|
|
|
|
|
|
2015-05-12 11:19:52 +02:00
|
|
|
local raillike_ids = {}
|
|
|
|
local raillike_cur_id = 0
|
|
|
|
function core.raillike_group(name)
|
|
|
|
local id = raillike_ids[name]
|
|
|
|
if not id then
|
|
|
|
raillike_cur_id = raillike_cur_id + 1
|
|
|
|
raillike_ids[name] = raillike_cur_id
|
|
|
|
id = raillike_cur_id
|
|
|
|
end
|
|
|
|
return id
|
|
|
|
end
|
2016-02-18 11:38:47 +01:00
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2016-02-18 11:38:47 +01:00
|
|
|
-- HTTP callback interface
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2021-12-17 18:31:29 +01:00
|
|
|
core.set_http_api_lua(function(httpenv)
|
2016-02-18 11:38:47 +01:00
|
|
|
httpenv.fetch = function(req, callback)
|
|
|
|
local handle = httpenv.fetch_async(req)
|
|
|
|
|
|
|
|
local function update_http_status()
|
|
|
|
local res = httpenv.fetch_async_get(handle)
|
|
|
|
if res.completed then
|
|
|
|
callback(res)
|
|
|
|
else
|
|
|
|
core.after(0, update_http_status)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
core.after(0, update_http_status)
|
|
|
|
end
|
|
|
|
|
|
|
|
return httpenv
|
2021-12-17 18:31:29 +01:00
|
|
|
end)
|
|
|
|
core.set_http_api_lua = nil
|
2015-01-16 07:54:26 +01:00
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2016-11-22 17:15:22 +01:00
|
|
|
function core.close_formspec(player_name, formname)
|
2018-07-09 20:11:35 +02:00
|
|
|
return core.show_formspec(player_name, formname, "")
|
2016-11-22 17:15:22 +01:00
|
|
|
end
|
2017-04-15 23:19:18 +02:00
|
|
|
|
2018-01-23 19:04:58 +01:00
|
|
|
|
2017-04-15 23:19:18 +02:00
|
|
|
function core.cancel_shutdown_requests()
|
|
|
|
core.request_shutdown("", false, -1)
|
|
|
|
end
|
2021-01-30 14:35:34 +01:00
|
|
|
|
|
|
|
|
2021-09-09 16:51:35 +02:00
|
|
|
-- Used for callback handling with dynamic_add_media
|
|
|
|
core.dynamic_media_callbacks = {}
|
2022-05-02 20:55:04 +02:00
|
|
|
|
|
|
|
|
2024-02-13 22:47:30 +01:00
|
|
|
-- Transfer of certain globals into seconday Lua environments
|
|
|
|
-- see builtin/async/game.lua or builtin/emerge/register.lua for the unpacking
|
2022-05-02 20:55:04 +02:00
|
|
|
|
|
|
|
local function copy_filtering(t, seen)
|
|
|
|
if type(t) == "userdata" or type(t) == "function" then
|
|
|
|
return true -- don't use nil so presence can still be detected
|
|
|
|
elseif type(t) ~= "table" then
|
|
|
|
return t
|
|
|
|
end
|
|
|
|
local n = {}
|
|
|
|
seen = seen or {}
|
|
|
|
seen[t] = n
|
|
|
|
for k, v in pairs(t) do
|
|
|
|
local k_ = seen[k] or copy_filtering(k, seen)
|
|
|
|
local v_ = seen[v] or copy_filtering(v, seen)
|
|
|
|
n[k_] = v_
|
|
|
|
end
|
|
|
|
return n
|
|
|
|
end
|
|
|
|
|
|
|
|
function core.get_globals_to_transfer()
|
|
|
|
local all = {
|
|
|
|
registered_items = copy_filtering(core.registered_items),
|
|
|
|
registered_aliases = core.registered_aliases,
|
2024-02-13 22:47:30 +01:00
|
|
|
registered_biomes = core.registered_biomes,
|
|
|
|
registered_ores = core.registered_ores,
|
|
|
|
registered_decorations = core.registered_decorations,
|
2023-06-24 17:58:43 +02:00
|
|
|
|
|
|
|
nodedef_default = copy_filtering(core.nodedef_default),
|
|
|
|
craftitemdef_default = copy_filtering(core.craftitemdef_default),
|
|
|
|
tooldef_default = copy_filtering(core.tooldef_default),
|
|
|
|
noneitemdef_default = copy_filtering(core.noneitemdef_default),
|
2022-05-02 20:55:04 +02:00
|
|
|
}
|
2022-05-09 18:20:10 +02:00
|
|
|
return all
|
2022-05-02 20:55:04 +02:00
|
|
|
end
|
2024-06-21 19:08:13 +02:00
|
|
|
|
|
|
|
do
|
|
|
|
local function valid_object_iterator(objects)
|
|
|
|
local i = 0
|
|
|
|
local function next_valid_object()
|
|
|
|
i = i + 1
|
|
|
|
local obj = objects[i]
|
|
|
|
if obj == nil then
|
|
|
|
return
|
|
|
|
end
|
|
|
|
if obj:is_valid() then
|
|
|
|
return obj
|
|
|
|
end
|
|
|
|
return next_valid_object()
|
|
|
|
end
|
|
|
|
return next_valid_object
|
|
|
|
end
|
|
|
|
|
|
|
|
function core.objects_inside_radius(center, radius)
|
|
|
|
return valid_object_iterator(core.get_objects_inside_radius(center, radius))
|
|
|
|
end
|
|
|
|
|
|
|
|
function core.objects_in_area(min_pos, max_pos)
|
|
|
|
return valid_object_iterator(core.get_objects_in_area(min_pos, max_pos))
|
|
|
|
end
|
|
|
|
end
|