luk3yx
/
sscsm
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify README.md.

This commit is contained in:
luk3yx 2020-02-14 22:38:33 +13:00
parent e5edf9a003
commit 57547cafb5
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -89,8 +89,9 @@ change in a future release.
- `sscsm.com_send(player_or_name, channel, msg)`: Sends `msg`
(a JSON-compatible object) to `player_or_name` on the SSCSM com channel
`channel`. Channel names should be `modname` or `modname:name` to prevent
conflicts. *Although the limit for server-to-client messages is 128MB, I
strongly recommend not sending large messages when not necessary.*
conflicts. *Although the theoretical limit for server-to-client messages is
128MiB, I strongly recommend not sending large messages when not
necessary.*
- `sscsm.com_send_all(channel, msg)`: Sends `msg` to all clients that are
running SSCSMs.
- `sscsm.register_on_com_receive(channel, function(name, msg))`: Registers a