Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SendPush


Name SendPush
Type Method
Summary Sends a message to the MUD and saves it in the command history buffer
Prototype long SendPush(BSTR Message);
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.

The command is saved in the command history buffer (use Send if you do NOT want to save it).


Note: Available in version 3.27 onwards.


VBscript example
world.SendPush "go north"
Jscript example
world.SendPush("go north");
PerlScript example
$world->SendPush("go north");
Python example
world.SendPush("go north")
Lua example
SendPush ("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
Introduced in version 3.27

See also ...

Function Description
LogSend Sends a message to the MUD and logs it
Note Sends a note to the output window
Send Sends a message to the MUD
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]

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