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


Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.Send


Name Send
Type Method
Summary Sends a message to the MUD
Prototype long Send(BSTR Message);
Description

This sends the specified text to the world. It is similar to typing it into the command window. However aliases, speedwalks, scripting prefixes, command-stacking etc. are not evaluated.

If you want to exactly emulate typing into the command window use world.Execute instead.

Use Send to send things to the MUD without further evaluation. Use Execute to allow other aliases to process what you sent.

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.

The command is not saved in the command history buffer (use SendPush if you want to save it).

VBscript example
world.send "go north"
Jscript example
world.Send("go north");
PerlScript example
$world->Send("go north");
Python example
world.Send("go north")
Lua example
Send ("go north")
Lua notes
You can supply multiple arguments, which are concatenated together.
Returns eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Sent OK

See also ...

Function Description
Execute Executes a command as if you had typed it into the command window
LogSend Sends a message to the MUD and logs it
Note Sends a note to the output window
Queue Queues a command for sending at the "speed walk" rate.
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
SendSpecial Sends a message to the MUD with various options

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.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

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.

[Home]