[Home] [Downloads] [Search] [Help/forum]

ChatPasteText

Script function

world.ChatPasteText

Read about scripting

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.


Available in MUSHclient 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


Return value

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

View list of return code meanings

See Also ...

Topics

Chat system
Getting started

Functions

(ChatAcceptCalls) Accepts incoming chat calls
(ChatCall) Calls a chat server (makes an outgoing call) using the MudMaster chat protocol
(ChatCallzChat) Calls a zChat chat server (makes an outgoing call)
(ChatDisconnect) Disconnects a current chat call
(ChatDisconnectAll) Disconnects all current chat calls
(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
(ChatMessage) Sends a message to a chat user (raw format)
(ChatNameChange) Changes your chat name
(ChatNote) Does a note using ANSI codes for the chat system
(ChatPasteEverybody) Pastes the clipboard contents to every connected person
(ChatPeekConnections) Sends a "peek connections" message to the specified chat user
(ChatPersonal) Sends a chat message to a particular person
(ChatPing) Sends a ping message to the specified chat user
(ChatRequestConnections) Sends a "request connections" message to the specified chat user
(ChatSendFile) Starts sending a file to the specified chat user
(ChatStopAcceptingCalls) Stops this world from accepting chat calls
(ChatStopFileTransfer) Stops a file transfer in progress to that chat user
(GetChatInfo) Get information about a chat connection
(GetChatList) Gets the list of chat sessions
(GetChatOption) Gets the value of a chat session option
(SetChatOption) Sets the value of a chat session option

(Help topic: function=ChatPasteText)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]