SendPkt
Script function

world.SendPkt

DOC_scripting Read about scripting

Type

Method

Summary

Sends a low-level packet of data to the MUD

Prototype

long SendPkt(BSTR Packet);

DOC_data_types View list of data type meanings

Description

This sends the specified text to the world.

A newline is not appended to it.

If the text contains the IAC character (0xFF) a second IAC character is NOT appended to it (as normally happens).

The text does not go through the OnPluginSend plugin callback, nor through the OnPluginSent callback.

The text is not echoed to the screen.

It is intended only for low-level sending of data for things like telnet negotiation options.

VBscript example

SendPkt Chr(255) & Chr (252) & Chr (31)  ' IAC WONT NAWS


Lua example

SendPkt (string.char (255, 252, 31))  -- IAC WONT NAWS


Lua notes

The data may include imbedded null characters (0x00) as the Lua string is not tested for being null-terminated.


Return value

eWorldClosed : The world is closed
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_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_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=SendPkt)

DOC_contents Documentation contents page