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

Send

Script function

world.Send

Read about scripting

Type

Method

Summary

Sends a message to the MUD

Prototype

long Send(BSTR Message);

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

View list of return code meanings

See Also ...

Topics

Commented softcode
Sending to the world

Functions

(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
(PasteCommand) Pastes text into the command window, replacing the current selection
(Queue) Queues a command for sending at the "speed walk" rate.
(SendImmediate) Sends a message to the MUD immediately, bypassing the speedwalk queue
(SendNoEcho) Sends a message to the MUD without echoing in the output window
(SendPkt) Sends a low-level packet of data 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
(SetCommand) Sends text to the command window
(SetCommandSelection) Selects specified columns in the command window

(Help topic: function=Send)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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]