mirror of
https://github.com/minetest/minetest_docs.git
synced 2024-08-20 22:14:17 +02:00
address review request
This commit is contained in:
parent
13b683dea5
commit
3940703fc9
@ -10,14 +10,16 @@ Allows server side mods (SSMs) communication to client side mods (CSMs) and vice
|
|||||||
|
|
||||||
* `channel_name`: string, modchannel name
|
* `channel_name`: string, modchannel name
|
||||||
|
|
||||||
Returns a object for use with <<Methods>>. Creates the channel if it does not exist and joins the channel.
|
Returns an object for use with <<Methods>>. Creates the channel if it does not exist and joins the channel.
|
||||||
|
|
||||||
==== minetest.register_on_modchannel_message(function(channel_name, sender, message))
|
==== minetest.register_on_modchannel_message(function(channel_name, sender, message))
|
||||||
|
|
||||||
* `channel_name`: string, modchannel name (already joined)
|
* `channel_name`: string, modchannel name (already joined)
|
||||||
* `sender`: string, empty if from a ssm, player name if from a client
|
* `sender`: string, empty if from a SSM, player name if from a client
|
||||||
* `message`: string, message
|
* `message`: string, message
|
||||||
|
|
||||||
|
Used for handling messages received from the client.
|
||||||
|
|
||||||
=== Methods
|
=== Methods
|
||||||
|
|
||||||
NOTE: `channel` here means the object returned by `minetest.mod_channel_join`.
|
NOTE: `channel` here means the object returned by `minetest.mod_channel_join`.
|
||||||
@ -26,11 +28,11 @@ NOTE: `channel` here means the object returned by `minetest.mod_channel_join`.
|
|||||||
|
|
||||||
The server will leave the channel, meaning no more messages from this channel on `minetest.register_on_modchannel_message`
|
The server will leave the channel, meaning no more messages from this channel on `minetest.register_on_modchannel_message`
|
||||||
|
|
||||||
TIP: set the channel to nil afterwords to free resources
|
TIP: Set the channel to `nil`` afterwords to free resources
|
||||||
|
|
||||||
==== channel:is_writeable()
|
==== channel:is_writeable()
|
||||||
|
|
||||||
* returns boolean, true if the channel is writeable
|
* Returns `bool`: `true` true if the channel is writeable, `false` if it's not.
|
||||||
|
|
||||||
==== channel:send_all(message)
|
==== channel:send_all(message)
|
||||||
|
|
||||||
@ -38,7 +40,7 @@ TIP: set the channel to nil afterwords to free resources
|
|||||||
|
|
||||||
Sends to all SSMs and CSMs on the channel.
|
Sends to all SSMs and CSMs on the channel.
|
||||||
|
|
||||||
TIP: The message will drop if channel is not writable or invalid
|
Caution: The message will not if channel is not writable or invalid.
|
||||||
|
|
||||||
== Client Side API
|
== Client Side API
|
||||||
|
|
||||||
@ -48,14 +50,16 @@ TIP: The message will drop if channel is not writable or invalid
|
|||||||
|
|
||||||
* `channel_name`: string, modchannel name
|
* `channel_name`: string, modchannel name
|
||||||
|
|
||||||
Returns a object for use with <<Methods>>. Creates the channel if it does not exist and joins the channel.
|
Returns an object for use with <<Methods>>. Creates the channel if it does not exist and joins the channel. Is equivalent to the the server side function.
|
||||||
|
|
||||||
==== minetest.register_on_modchannel_message(function(channel_name, sender, message))
|
==== minetest.register_on_modchannel_message(function(channel_name, sender, message))
|
||||||
|
|
||||||
* `channel_name`: string, modchannel name (already joined and recieved acknowledgement)
|
* `channel_name`: string, modchannel name (already joined and recieved acknowledgement)
|
||||||
* `sender`: string, empty if from a ssm, player name if from a client
|
* `sender`: string, empty if from a SSM, player name if from a client
|
||||||
* `message`: string, message
|
* `message`: string, message
|
||||||
|
|
||||||
|
Used for handling messages received from the client. Is equivalent to the the server side function.
|
||||||
|
|
||||||
==== minetest.register_on_modchannel_signal(function(channel_name, signal))
|
==== minetest.register_on_modchannel_signal(function(channel_name, signal))
|
||||||
* `channel_name`: string, channel name that the signal has come in on
|
* `channel_name`: string, channel name that the signal has come in on
|
||||||
* `signal`: integer, 0 - 5
|
* `signal`: integer, 0 - 5
|
||||||
@ -73,13 +77,13 @@ NOTE: `channel` here means the object returned by `minetest.mod_channel_join`.
|
|||||||
|
|
||||||
==== channel:leave()
|
==== channel:leave()
|
||||||
|
|
||||||
The server will leave the channel, meaning no more messages from this channel on `minetest.register_on_modchannel_message`
|
The client will leave the channel, meaning no more messages from this channel on `minetest.register_on_modchannel_message`
|
||||||
|
|
||||||
TIP: set the channel to nil afterwords to free resources
|
TIP: Set the channel to `nil`` afterwords to free resources
|
||||||
|
|
||||||
==== channel:is_writeable()
|
==== channel:is_writeable()
|
||||||
|
|
||||||
* returns boolean, true if the channel is writeable
|
* Returns `bool`: `true` true if the channel is writeable, `false` if it's not.
|
||||||
|
|
||||||
==== channel:send_all(message)
|
==== channel:send_all(message)
|
||||||
|
|
||||||
@ -87,4 +91,4 @@ TIP: set the channel to nil afterwords to free resources
|
|||||||
|
|
||||||
Sends to all SSMs and CSMs on the channel.
|
Sends to all SSMs and CSMs on the channel.
|
||||||
|
|
||||||
TIP: The message will drop if channel is not writable or invalid
|
Caution: The message will not if channel is not writable or invalid.
|
Loading…
Reference in New Issue
Block a user