MUSHclient scripting

Description of MUSHclient world function: world.SetEntity

Name	SetEntity
Type	Method
Summary	Sets the value of an MXP entity
Prototype	`void SetEntity(BSTR Name, BSTR Contents);` View list of data type meanings
Description	Sets the value of an MXP (custom) entity. If the supplied contents is the empty string, the entity is deleted. If the entity already exists it is replaced. No checking is made for the name or contents strings' values (for example, they might be just spaces). It is up to you to use sensible values. Custom entities are stored separately from standard entities. Thus you cannot replace, for example, the "lt" entity. Note: Available in version 3.66 onwards.
VBscript example	`SetEntity "foo", "bar"`
Jscript example	`SetEntity ("foo", "bar");`
Lua example	`SetEntity ("foo", "bar)`
Lua notes	`The contents are optional. If omitted they default to the empty string, and thus the named entity will be deleted.`
Returns	`Nothing.`
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
SetVariable	Sets the value of a variable

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.