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

GetXMLEntity

Script function

world.GetXMLEntity

Read about scripting

Type

Method

Summary

Retrieves the value of a standard entity

Prototype

BSTR GetXMLEntity(BSTR Entity);

View list of data type meanings

Description

Returns the value of a standard XML/MXP (HTML) entity.

To get user (server defined) entities use GetEntity.

Entity names are the standard HTML ones. There is a list on this page:

http://www.gammon.com.au/mushclient/mxpentities.htm

You can also use entities in the form: #nnn where nnn is a decimal number in the range 32 to 255.

You can also use entities in the form: #xhh where hh is a hexadecimal number in the range 20 to FF.

The entity name should *not* include the leading ampersand or trailing semicolon that you use in XML, MXP or HTML.


Available in MUSHclient version 3.66 onwards.



VBscript example

world.Note world.GetXMLEntity("lt")


Jscript example

world.Note (world.GetXMLEntity("lt"));


PerlScript example

$world->Note (world.GetXMLEntity("lt"));


Python example

world.Note (world.GetXMLEntity ("lt"))


Lua example

Note (GetXMLEntity ("lt"))


Return value

The contents of the specified entity, or an empty string if no such entity is found, or the syntax is invalid (eg. #999).


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
(GetVariable) Gets the contents of a variable
(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
(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
(UdpPortList) Returns an array of all the UDP ports in use by this world
(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=GetXMLEntity)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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.

[Home]


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]