MUSHclient scripting

Description of MUSHclient world function: world.GetXMLEntity

Name	GetXMLEntity
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. Note: Available in 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"))`
Returns	`The contents of the specified entity, or an empty string if no such entity is found, or the syntax is invalid (eg. #999).`
Introduced in version	3.66

See also ...

Function	Description
GetEntity	Retrieves the value of an MXP server-defined entity
GetVariable	Gets the contents of a variable
SetEntity	Sets the value of an MXP entity

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.