Mirrorlandia_minetest/minetest_docs
1
0
Fork 0
mirror of https://github.com/minetest/minetest_docs.git synced 2024-07-07 08:35:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

small format tweaks

Browse Source
This commit is contained in:
unknown 2022-01-03 23:58:47 -05:00
parent 1e29cab1c6
commit fe0524f994
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/modchannels.adoc
View File

@ -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