world.Send

MUSHclient script function (Method)

Sends a message to the MUD

Prototype

long Send(BSTR Message);

Data type meanings

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.

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