SendImmediate
Script function

world.SendImmediate

DOC_scripting Read about scripting

Type

Method

Summary

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

Prototype

long SendImmediate(BSTR Message);

DOC_data_types View list of 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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_send_paste Commented softcode
DOC_send Sending to the world

Functions

FNC_Execute Execute (Executes a command as if you had typed it into the command window)
FNC_LogSend LogSend (Sends a message to the MUD and logs it)
FNC_Note Note (Sends a note to the output window)
FNC_PasteCommand PasteCommand (Pastes text into the command window, replacing the current selection)
FNC_Queue Queue (Queues a command for sending at the "speed walk" rate.)
FNC_Send Send (Sends a message to the MUD)
FNC_SendNoEcho SendNoEcho (Sends a message to the MUD without echoing in the output window)
FNC_SendPkt SendPkt (Sends a low-level packet of data to the MUD)
FNC_SendPush SendPush (Sends a message to the MUD and saves it in the command history buffer)
FNC_SetCommand SetCommand (Sends text to the command window)

(Help topic: function=SendImmediate)

DOC_contents Documentation contents page