Script function
world.UdpSend
Read about scripting
Type
Method
Summary
Sends a packet over the network using the UDP protocol
Prototype
long UdpSend(BSTR IP, short Port, BSTR Text);
View list of data type meanings
Description
This sends a single UDP (User Datagram Protocol) packet over the network, to the specified IP address and port.
The intention here is to communicate with other programs, such as the status-bar stand-alone program using UDP to send short messages.
You can broadcast to more than one PC by using a broadcast address.
The address must be a dotted number, not a name (eg. 10.0.0.8)
Available in MUSHclient version 3.56 onwards.
VBscript example
UdpSend "10.0.0.3", 4111, "magic,textcolour,5555"
Jscript example
UdpSend ("10.0.0.3", 4111, "magic,textcolour,5555")
Lua example
UdpSend ("10.0.0.3", 4111, "magic,textcolour,5555")
Return value
If the packet was sent successfully, zero is returned.
If the address could not be decoded, -1 is returned;
For other socket errors the Windows socket error number.
See Also ...
Functions
(GetUdpPort) Find a free port for UDP listening
(UdpListen) Listens for incoming packets using the UDP protocol
(UdpPortList) Returns an array of all the UDP ports in use by this world
(Help topic: function=UdpSend)