Script function
world.GetEntity
Read about scripting
Type
Method
Summary
Retrieves the value of an MXP server-defined entity
Prototype
BSTR GetEntity(BSTR Name);
View list of data type meanings
Description
Returns the value of an entity defined by the MUD server using MXP.
eg.
If the server sent:
<!ENTITY foo "bar">
Then if you did this:
world.Note world.GetEntity ("foo")
You would see "bar" displayed.
To get standard (automatically defined) entities use GetXMLEntity.
Available in MUSHclient version 3.30 onwards.
VBscript example
world.Note world.GetEntity ("foo")
Jscript example
world.Note (world.GetEntity ("foo"));
PerlScript example
$world->Note (world.GetEntity ("foo"));
Python example
world.Note (world.GetEntity ("foo"))
Lua example
Note (GetEntity ("foo"))
Return value
The contents of the specified entity, or an empty string if no such entity is found.
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.
(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
(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
(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=GetEntity)