Description of MUSHclient world function: world.SendSpecial
||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.
Note: Available in version 4.14 onwards.
world.SendSpecial "go north", vbTrue, vbFalse, vbFalse, vbTrue
world.SendSpecial ("go north", true, false, false, true);
SendPush ("go north", true, false, true, false)
The boolean arguments are optional and default to false.
eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Sent OK
View list of return code meanings
|Introduced in version
See also ...
||Sends a message to the MUD and logs it
||Sends a note to the output window
||Sends a message to the MUD
||Sends a message to the MUD and saves it in the command history buffer
Search for script function
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.
view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
view a list of the data types used in function prototypes
View all functions
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )