world.SendPush

MUSHclient script function (Method) — introduced in version 3.27

Sends a message to the MUD and saves it in the command history buffer

Prototype

long SendPush(BSTR Message);

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.

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

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.

Return value

eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Sent OK

Return code meanings

Related topic

Sending to the world

See also