SetEntity
Script function world.SetEntity Read about scripting 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.` 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.
Return value
    Nothing.
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.) GetEntity (Retrieves the value of an MXP server-defined entity) 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) SetVariable (Sets the value of a variable) 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=SetEntity) Documentation contents page