Commands BuildContextualMenuForItem Arguments view Description The chat panel this context menu is associated with, if any. Name in Description Called for every object that the user can access a contextual/action menu. This handler is called when the selection changes in a table or right before the menu is shown, allowing you to provide a list of titles to show. Name build contextual menu for item UnnamedArgument Description Object that the user has requested a contextual menu for. Can be a member, chat room, direct chat, transcript, connection, text, etc. Connected Description Called when we have just finished connecting to a chat server. Name connected UnnamedArgument Description The chat connection. Disconnecting Description Called when we are in the process of disconnecting from a chat server. Commands and messages can still be sent to the server. Name disconnecting UnnamedArgument Description The chat connection. HandleClickedContextualMenuItem Arguments object Description Item the menu item was built for, can be a member, chat room, direct chat, transcript, chat connection, etc. Name for submenu Description A list of parent menu item titles the clicked menu item was when displayed. You only need to reference this when you use multiple items with the same name in different sub-menus. Name within Description Called when the user clicks on one of the supplied menu item titles you returned from the "build contextual menu for item". Name handle clicked contextual menu item UnnamedArgument Description Menu item title you returned from the "build contextual menu for item" HandleClickedLink Arguments view Description The chat panel this link was clicked in. Name in Description Called when a (currently unhandled) link is clicked in a conversation. Return true to prevent Colloquy and other plugins from handling this clicked link. Name handle clicked link UnnamedArgument Description The URL of the clicked link. Idle Description Automatically starts firing as soon as the script initializes, it will continue to fire periodically until the user quits the application. The default interval is 5 seconds, return a new interval to change the wait period for the next call. Name idle JoinedChatRoom Description Called when we join a room. Name joined chat room UnnamedArgument Description The chat room. KickedFromRoom Arguments by Description The member who kicked us out. Name by reason Description The reason given for kicking us out. Name for Description Called when we are kicked out of a room by another member. Name kicked from room UnnamedArgument Description The chat room. Load Arguments path Description The path the script was loaded from. Name from Description Called when the script is loaded into the host application. Name load MemberJoined Arguments room Description The chat room. Name in Description Called when a member joins a room we are also a member of. Name member joined UnnamedArgument Description The member. MemberKicked Arguments by Description The member who kicked the other member out. Name by reason Description The reason the member was kicked. Name for room Description The chat room. Name from Description Called when a member is kicked out of a room we are also a member of. Name member kicked UnnamedArgument Description The member. MemberParted Arguments reason Description The reason the member left. Name for room Description The chat room. Name from Description Called when a member leaves a room we are also a member of. Name member parted UnnamedArgument Description The member. PartingChatRoom Description Called when we are in the process of leaving a room. Messages can still be sent. Name parting chat room UnnamedArgument Description The chat room. PerformNotification Arguments context Description Notification specific context information. Usually contains a human-readable message to display. Name with preferences Description Preferences for the notification. From the Notification preferences panel. Name and Description Called for every notification event like Buddy Offline, Name Mentioned, Message Ignored, etc. If you want to trigger on select events you should use a more specific handler; this handler is intended for limited context, high-level notifications only. Name perform notification UnnamedArgument Description Identifier of the notification to perform. ProcessIncomingChatMessage Arguments user Description The user this message came from. Name from view Description The chat room or direct chat this message is in. Name in Description Called when an incoming message is sent to us or a room we are in. (Any messages echoed to the screen that are sent from the local user will also be passed through this handler.) Name process incoming chat message UnnamedArgument Description The incoming message. Message and properties are modifiable. ProcessOutgoingChatMessage Arguments view Description The chat room or direct chat this message is in. Name in Description Called when a message is sent from us to a user or room we are in. Name process outgoing chat message UnnamedArgument Description The outgoing message. Message and properties are modifiable. ProcessSubcodeReply Arguments arguments Description Any arguments given with the reply. Name with connection Description The connection this reply came on. Name on user Description The user this reply came from. Name from Description Called when an unhandled CTCP reply gets sent to us from another user. Return true to prevent other plugins from processing this reply. Name process subcode reply UnnamedArgument Description CTCP request to process. ProcessSubcodeRequest Arguments arguments Description Any arguments given with the request. Name with connection Description The connection this request came on. Name on user Description The user this request came from. Name from Description Called when an unhandled CTCP request gets sent to us from another user. Return true to prevent other plugins from processing this request. Name process subcode request UnnamedArgument Description CTCP request to process. ProcessUserCommand Arguments arguments Description Any arguments given with the command. Name with view Description The panel the command was entered in. Name for Description Called when the user types an unhandled "/command". Return true to prevent other plugins from processing this command. If no plugins return true, the command is sent "raw" Name process user command UnnamedArgument Description Command to process. TopicChanged Arguments by Description The member who changed the topic. Name by room Description The chat room. Name in topic Description The new room topic. Name to Description Called when a member changes the room topic. Name topic changed Unload Description Called right before the script is unloaded from the host application. The script might be loaded again if a reload is being performed. Name unload Description Commands to be implemented by plug-ins. Name Chat Plug-In Suite