SendPush
Script function

world.SendPush

DOC_scripting Read about scripting

Type

Method

Summary

Sends a message to the MUD and saves it in the command history buffer

Prototype

long SendPush(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.

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 saved in the command history buffer (use Send if you do NOT want to save it).

VBscript example

world.SendPush "go north"


Jscript example

world.SendPush("go north");


PerlScript example

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


Python example

world.SendPush("go north")


Lua example

SendPush ("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_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_SetCommand SetCommand (Sends text to the command window)

(Help topic: function=SendPush)

DOC_contents Documentation contents page