luanti_lsp_api/api/classes/modchannel.lua

---@meta
---ModChannel
-------------

-- An interface to use mod channels on client and server.
---@class mt.ModChannel
local ModChannel

-- - Server leaves channel `channel_name`.
-- - No more incoming or outgoing messages can be sent to this channel from
--   server mods.
-- - This invalidate all future object usage.
-- - Ensure you set mod_channel to nil after that to free Lua resources.
function ModChannel:leave() end

-- Returns true if channel is writeable and mod can send over it.
---@return boolean
function ModChannel:is_writeable() end

-- Send `message` though the mod channel.
--
-- - If mod channel is not writeable or invalid, message will be dropped.
-- - Message size is limited to 65535 characters by protocol.
---@param message string
function ModChannel:send_all(message) end

-- Server joins channel `channel_name`, and creates it if necessary.
--
-- You should listen for incoming messages with
-- `minetest.register_on_modchannel_message`.
---@param channel_name string
---@return mt.ModChannel
function minetest.mod_channel_join(channel_name) end