[Home] [Downloads] [Search] [Help/forum]


Script function


Read about scripting




Sends a message to the MUD with various options


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

View list of data type meanings


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 ...


Commented softcode
Sending to the world


(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)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]