Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.ChatPasteText

Name ChatPasteText
Type Method
Summary Pastes the clipboard contents to that person
Prototype long ChatPasteText(long ID);

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

Note: Available in version 3.37 onwards.
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
Returns eChatIDNotFound: No call with that chat ID
eClipboardEmpty: No text on the clipboard
eOK: Sent OK

View list of return code meanings
Introduced in version 3.37

See also ...

Function Description
ChatEverybody Sends a chat message to every connected chat user
ChatGetID Looks up what chat ID (identifier) corresponds to a particular chat name
ChatGroup Sends a chat message to every connected chat user in the specified group
ChatID Sends a chat message to a particular chat session
ChatPasteEverybody Pastes the clipboard contents to every connected person
ChatPersonal Sends a chat message to a particular person
GetChatList Gets the list of chat sessions

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home