From fe0524f994a3c99b6f18e8bda4481e7592ee5419 Mon Sep 17 00:00:00 2001 From: unknown <24964441+wsor4035@users.noreply.github.com> Date: Mon, 3 Jan 2022 23:58:47 -0500 Subject: [PATCH] small format tweaks --- doc/modchannels.adoc | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/doc/modchannels.adoc b/doc/modchannels.adoc index cec8fdb..455d932 100644 --- a/doc/modchannels.adoc +++ b/doc/modchannels.adoc @@ -1,6 +1,6 @@ = Modchannels -allows server side mods(SSMs) comunication to client side mods(CSMs) and vice versa. +Allows server side mods (SSMs) communication to client side mods (CSMs) and vice versa. == Server Side API @@ -21,16 +21,18 @@ allows server side mods(SSMs) comunication to client side mods(CSMs) and vice ve === Methods -==== leave() +NOTE: `channel` here means the object returned by `minetest.mod_channel_join`. + +==== channel:leave() * server leaves the channel, no more messages from this channel on `minetest.register_on_modchannel_message` * set the ref to nil afterwords to free resources -==== is_writeable() +==== channel:is_writeable() * returns boolean, true if the channel is writeable -==== send_all(message) +==== channel:send_all(message) * `message`: string, limited to 65535 bytes * sends to all ssm and csm on the channel @@ -66,16 +68,18 @@ allows server side mods(SSMs) comunication to client side mods(CSMs) and vice ve === Methods -==== leave() +NOTE: `channel` here means the object returned by `minetest.mod_channel_join`. + +==== channel:leave() * server leaves the channel, no more messages from this channel on `minetest.register_on_modchannel_message` * set the ref to nil afterwords to free resources -==== is_writeable() +==== channel:is_writeable() * returns boolean, true if the channel is writeable -==== send_all(message) +==== channel:send_all(message) * `message`: string, limited to 65535 bytes * sends to all ssm and csm on the channel