[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.UdpPortList

Name UdpPortList
Type Method
Summary Returns an array of all the UDP ports in use by this world
Prototype VARIANT UdpPortList();

View list of data type meanings


Returns a variant array of all the UDP ports that are being listened to by plugins for this world. eg.


Note: Available in version 3.60 onwards.

VBscript example
dim portList

portList= world.UdpPortList

If Not IsEmpty (portList) Then
  For Each v In portList
    world.note v 

End If
Lua example
-- show all ports

for _, v in pairs (UdpPortList()) do 
  Note (v) 
Returns If there are no ports in use then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the port numbers in use.

Use "lbound" and "ubound" to find the bounds of the array of variables (ie. the number of ports in the list).
Introduced in version 3.60

See also ...

Function Description
GetUdpPort Find a free port for UDP listening
UdpListen Listens for incoming packets using the UDP protocol
UdpSend Sends a packet over the network using the UDP protocol

Search for script function

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.

Search for:   

Leave blank to show all functions.

Return codes

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

You can view a list of the return codes

Function prototypes

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

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]