world.SendImmediate

MUSHclient script function (Method) — introduced in version 3.41

Sends a message to the MUD immediately, bypassing the speedwalk queue

Prototype

long SendImmediate(BSTR Message);

Data type meanings

Description

This sends the specified text to the world. It is like typing it into the command window. If there is a queue of commands in the speedwalk queue, this command "jumps the queue" - that is, it gets sent immediately.

The intention here is to use it for commands (like "say", "tell") that are not dependent on a speedwalk sequence finishing.

The command is not saved in the command history buffer nor is it logged.

VBscript example

world.SendImmediate "go north"

Jscript example

world.SendImmediate("go north");

PerlScript example

$world->SendImmediate("go north");

Python example

world.SendImmediate("go north")

Lua example

SendImmediate ("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

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.
Send	Sends a message 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