Script function
world.UdpPortList
Read about scripting
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
Description
Returns a variant array of all the UDP ports that are being listened to by plugins for this world. eg.
4223
4224
Available in MUSHclient version 3.60 onwards.
VBscript example
dim portList
portList= world.UdpPortList
If Not IsEmpty (portList) Then
For Each v In portList
world.note v
Next
End If
Lua example
-- show all ports
for _, v in pairs (UdpPortList()) do
Note (v)
end
Return value
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).
See Also ...
Topic
Information
Functions
(Debug) Displays debugging information about the world
(EchoInput) A flag to indicate whether we are echoing command input to the output window
(GetConnectDuration) Returns the number of seconds this world has been connected.
(GetEntity) Retrieves the value of an MXP server-defined entity
(GetHostAddress) Returns a list of IP addresses that correspond to a host name on the Internet
(GetHostName) Returns the host name that corresponds to an IP address on the Internet
(GetInfo) Gets information about the current world
(GetInternalCommandsList) Returns a list of the internal MUSHclient command names
(GetLineCount) Gets count of lines received
(GetLineInfo) Gets details about a specified line in the output window
(GetLinesInBufferCount) Returns the number of lines in the output window
(GetMainWindowPosition) Returns the position and size of the main MUSHclient window
(GetNotepadWindowPosition) Returns the position and size of the specified notepad window
(GetNotes) Gets the world's notes
(GetQueue) Returns a variant array which is a list of queued commands
(GetReceivedBytes) Returns the number of bytes received from the world
(GetRecentLines) Assembles a block of text from recent MUD output
(GetSelectionEndColumn) Returns the endling column of the selection in the output window
(GetSelectionEndLine) Returns the last line of the selection in the output window
(GetSelectionStartColumn) Returns the starting column of the selection in the output window
(GetSelectionStartLine) Returns the starting line of the selection in the output window
(GetSentBytes) Returns the number of bytes sent to the world
(GetStyleInfo) Gets details about a specified style run for a specified line in the output window
(GetSysColor) Gets the colour of various windows items
(GetSystemMetrics) Returns selected system information from Windows
(GetUdpPort) Find a free port for UDP listening
(GetWorldID) Returns the 24-character ID of the current world
(GetWorldWindowPosition) Returns the position and size of the current world window
(GetWorldWindowPositionX) Returns the position and size of a specific world window
(GetXMLEntity) Retrieves the value of a standard entity
(IsConnected) Tests to see if the world is connected to the MUD server
(SetChanged) Sets or clears the "document has changed" flag
(SetEntity) Sets the value of an MXP entity
(UdpListen) Listens for incoming packets using the UDP protocol
(UdpSend) Sends a packet over the network using the UDP protocol
(Version) Gets the MUSHclient version string.
(WorldAddress) Returns the TCP/IP address of the current world.
(WorldName) Gets the world's name
(WorldPort) Returns the port number of the current world.
(Help topic: function=UdpPortList)