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

MUSHclient scripting

Description of MUSHclient world function: world.GetEntity

Name GetEntity
Type Method
Summary Retrieves the value of an MXP server-defined entity
Prototype BSTR GetEntity(BSTR Name);

View list of data type meanings


Returns the value of an entity defined by the MUD server using MXP.


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.

Note: Available in 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"))
Returns The contents of the specified entity, or an empty string if no such entity is found.
Introduced in version 3.30

See also ...

Function Description
GetVariable Gets the contents of a variable
GetXMLEntity Retrieves the value of a standard entity
SetEntity Sets the value of an MXP entity

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]