Cmd: Difference between revisions
Jump to navigation
Jump to search
(Created page with "cmd is a feature of OWOT that allows scripts to exchange string messages. ==Using cmd in scripts== Receiving cmd messages: <syntaxhighlight lang="javascript"> // Start receiving cmd messages w.broadcastReceive(); // cmd message event w.on("cmd", e => { /* Process the message here. Properties: kind = always "cmd" data = the actual text of the cmd message sender = the sender's channel id...") |
Dat Hack3r (talk | contribs) (Added some examples as per Dimka's request.) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 25: | Line 25: | ||
Sending [[cmd]] messages: <syntaxhighlight lang="javascript"> | Sending [[cmd]] messages: <syntaxhighlight lang="javascript"> | ||
// send a message with the text "hi" without | // send a message with the text "hi" without the username and Uvias ID | ||
w.broadcastCommand("hi", false); | w.broadcastCommand("hi", false); | ||
// send a message with the text "hi" with | // send a message with the text "hi" with the username and Uvias ID | ||
w.broadcastCommand("hi", true); | w.broadcastCommand("hi", true); | ||
// are the same as above | |||
network.cmd("hi", false); | |||
network.cmd("hi", true); | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==<code>com:</code> and <code>comu:</code> links== | |||
[[cmd]] messages can also be sent with special links. This allows for interactive scripts.<br> | |||
For example: | |||
* The link <code>com:hi</code> will send a "hi" cmd message without the username and Uvias ID. | |||
* The link <code>comu:hi</code> will send a "hi" cmd message with the username and Uvias ID. | |||
==Limitations== | ==Limitations== | ||
| Line 40: | Line 51: | ||
==References== | ==References== | ||
<references /> | <references /> | ||
[[Category:Documentation]] | |||
Latest revision as of 19:56, 2 April 2024
cmd is a feature of OWOT that allows scripts to exchange string messages.
Using cmd in scripts
Receiving cmd messages:
// Start receiving cmd messages
w.broadcastReceive();
// cmd message event
w.on("cmd", e =>
{
/*
Process the message here.
Properties:
kind = always "cmd"
data = the actual text of the cmd message
sender = the sender's channel id
source = always "cmd"
username (optional) = the sender's username
id (optional) = the sender's Uvias ID
*/
console.table(e);
});
Sending cmd messages:
// send a message with the text "hi" without the username and Uvias ID
w.broadcastCommand("hi", false);
// send a message with the text "hi" with the username and Uvias ID
w.broadcastCommand("hi", true);
// are the same as above
network.cmd("hi", false);
network.cmd("hi", true);
com: and comu: links
cmd messages can also be sent with special links. This allows for interactive scripts.
For example:
- The link
com:hiwill send a "hi" cmd message without the username and Uvias ID. - The link
comu:hiwill send a "hi" cmd message with the username and Uvias ID.
Limitations
cmd has some limitations:
- You can send only 192 cmd messages per second[1]
- The text of a cmd message can't be longer than 2048[2]
- cmd can only transmit strings, data of other types has to be serialized into a string[2]