Script function
world.SendSpecial
Read about scripting
Type
Method
Summary
Sends a message to the MUD with various options
Prototype
long SendSpecial(BSTR Message, BOOL Echo, BOOL Queue, BOOL Log, BOOL History);
View list of 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.
Available in MUSHclient version 4.14 onwards.
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
View list of return code meanings
See Also ...
Topics
Commented softcode
Sending to the world
Functions
(LogSend) Sends a message to the MUD and logs it
(Note) Sends a note to the output window
(PasteCommand) Pastes text into the command window, replacing the current selection
(Send) Sends a message to the MUD
(SendImmediate) Sends a message to the MUD immediately, bypassing the speedwalk queue
(SendNoEcho) Sends a message to the MUD without echoing in the output window
(SendPkt) Sends a low-level packet of data to the MUD
(SendPush) Sends a message to the MUD and saves it in the command history buffer
(SetCommand) Sends text to the command window
(SetCommandSelection) Selects specified columns in the command window
(Help topic: function=SendSpecial)