SendSpecial
Script function

world.SendSpecial

DOC_scripting Read about scripting

Type

Method

Summary

Sends a message to the MUD with various options

Prototype

long SendSpecial(BSTR Message, BOOL Echo, BOOL Queue, BOOL Log, BOOL History);

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.

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.

* If "echo" is true, the command will be echoed in the output window.

* If "queue" is true, the command will be queued (after any other pending commands), otherwise it will be sent immediately

* If "log" is true, the command will be logged to the log file, if one is open, and logging commands is enabled.

* If "history" is true the command will be added to the command history buffer.

VBscript example

world.SendSpecial "go north", vbTrue, vbFalse, vbFalse, vbTrue


Jscript example

world.SendSpecial ("go north", true, false, false, true);


Lua example

SendPush ("go north", true, false, true, false)


Lua notes

The boolean arguments are optional and default to false.


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_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_Send Send (Sends a message to the MUD)
FNC_SendImmediate SendImmediate (Sends a message to the MUD immediately, bypassing the speedwalk queue)
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)
FNC_SetCommandSelection SetCommandSelection (Selects specified columns in the command window)

(Help topic: function=SendSpecial)

DOC_contents Documentation contents page