MUSHclient scripting

Description of MUSHclient world function: world.UdpSend

Name	UdpSend
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) Note: Available in 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")`
Returns	`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.`
Introduced in version	3.56

See also ...

Function	Description
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

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.