[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.SendImmediate


Name SendImmediate
Type Method
Summary Sends a message to the MUD immediately, bypassing the speedwalk queue
Prototype long SendImmediate(BSTR Message);

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.


Note: Available in version 3.41 onwards.


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.
Returns eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Sent OK

View list of return code meanings

Introduced in version 3.41

See also ...

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

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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]