world.ChatPasteText

MUSHclient script function (Method) — introduced in version 3.37

Pastes the clipboard contents to that person

Prototype

long ChatPasteText(long ID);

Data type meanings

Description

This pastes the clipboard contents to the person with that chat ID.

The clipboard must contain text - if it does the entire contents will be pasted to that person (as a personal chat message, so it will work with other clients), and echoed on your output window as well.

You could use that to exchange aliases, triggers, messages from the screen, and so on.

Each call is identified by its "chat ID" - each chat session has a unique ID, which starts at one, and is incremented by one, per world.

You can use GetChatList to find a list of chat IDs that is current.

You can use ChatGetID to find the chat ID corresponding to a particular chat name.

VBscript example

ChatPasteText 5  ' paste to user 5
ChatPasteText ChatGetID ("nick")  ' paste to Nick

Jscript example

ChatPasteText (5);   // paste to user 5
ChatPasteText (ChatGetID ("nick"));  // paste to Nick

PerlScript example

ChatPasteText (5);   # paste to user 5
ChatPasteText (ChatGetID ("nick"));  # paste to Nick

Python example

world.ChatPasteText (5)   # paste to user 5
world.ChatPasteText (world.ChatGetID ("nick"))  # paste to Nick

Lua example

ChatPasteText (5)   -- paste to user 5
ChatPasteText (ChatGetID ("nick"))  -- paste to Nick

Return value

eChatIDNotFound: No call with that chat ID
eClipboardEmpty: No text on the clipboard
eOK: Sent OK

Return code meanings

Related topic

Chat system

See also