world.SendSpecial

MUSHclient script function (Method) — introduced in version 4.14

Sends a message to the MUD with various options

Prototype

long SendSpecial(BSTR Message, BOOL Echo, BOOL Queue, BOOL Log, BOOL History);

Data type meanings

Description

This sends the specified text to the world. It is like typing it into the command window.

A newline character is appended to the text you supply, as MUD commands normally are terminated with a newline.

The text may include imbedded newlines.

If the text has a trailing newline it is removed. In other words, text with a trailing newline will not end up with two newlines when sent to the MUD.

* If "echo" is true, the command will be echoed in the output window.

* If "queue" is true, the command will be queued (after any other pending commands), otherwise it will be sent immediately

* If "log" is true, the command will be logged to the log file, if one is open, and logging commands is enabled.

* If "history" is true the command will be added to the command history buffer.

VBscript example

world.SendSpecial "go north", vbTrue, vbFalse, vbFalse, vbTrue

Jscript example

world.SendSpecial ("go north", true, false, false, true);

Lua example

SendPush ("go north", true, false, true, false)

Lua notes

The boolean arguments are optional and default to false.

Return value

eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Sent OK

Return code meanings

Related topic

Sending to the world

See also