world.GetEntity

MUSHclient script function (Method) — introduced in version 3.30

Retrieves the value of an MXP server-defined entity

Prototype

BSTR GetEntity(BSTR Name);

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.

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.

Related topic

Information

See also