Classes MVChatConnection Attributes localUser Description Current local user when connected. Name local user nickname Description Current nickname on the server. Name nickname nicknamePassword Description The nickname's password. Name nickname password password Description Password to connect to the server. Name password proxy Description What system proxy server to use. Name proxy scriptTypedAwayMessage Description Away message for other users to see that your not there. Name away message scriptTypedEncoding Description The default connection encoding that is used when sending raw messages or chat messages without a specific encoding. Name encoding server Description Server IP address or domain name. Name server address serverPort Description Port to connect on. Name port number status Description Current connection status. Name status scriptUniqueIdentifier Description The unique identifier of the connection. Name id urlString Description Chat URL containing nickname, server and port. Name URL Description Manages all chat communication with a chat server. Name connection PluralName connections MVChatRoom Attributes attributes Description Room attributes containing various items. Name attributes bannedUsersArray Description Current chat room members. Name banned users dateJoined Description Date we joined the room. Missing value if we haven't joined yet. Name date joined dateParted Description Date we parted the room. Missing value if we haven't parted yet. Name date parted displayName Description Full room name without any prefixes. Name display name isJoined Description Are we currently in the room? Name joined name Description Full room name. Name name scriptTypedEncoding Description Default encoding for outgoing messages. Name encoding scriptUniqueIdentifier Description The unique identifier of the room. Name id urlString Description The full room URL containing the server and room name. Name URL Description Represents a join chat room. Name chat room PluralName chat rooms MVChatUser Attributes address Description The address the user connected to the server from. Sometimes this is a fake (masked) address. Name address attributes Description User attributes containing various items. Name attributes dateConnected Description The date the user connected to the server. Name date connected dateDisconnected Description The date the user disconnected from the server. This will not be available for all users. Name date disconnected dateUpdated Description The last time the refresh information command finished. Name date updated displayName Description Display name, almost always the nickname. Name display name idleTime Description The number of seconds the user has been idle on the server. Name idle time nickname Description The current nickname. Name name realName Description The real name supplied by the user, not always a person's real name. Name real name scriptTypedAwayMessage Description The user's away message. Name away message scriptUniqueIdentifier Description The unique identifier of the user on the server. Name id serverAddress Description The server address the user is connected to. This might be a different address than you are connected to, since servers are sometimes clustered. Name server address status Description The current status of the user. Name status username Description The user name supplied by the user. Name user name Description Represents a user on a chat server. Many properties of this class require the refresh information command to be called first on the instance. Name chat user PluralName chat users MVFileTransfer Attributes finalSize Description The final expected size (in bytes) of the file. Name final size hostString Description The address of the other user engaged in the transfer. Name host address isPassive Description Is the transfer using passive mode? Name passive port Description The port this the transfer is using. Name port scriptFilePath Description The file this transfer is associated with. Name file scriptType Description The type of this transfer. Name type startDate Description The date and time this file transfer started. Name start date startOffset Description The location (offset) in the file where transfer was resumed. Name start offset status Description The current status of the transfer. Name status transferred Description The current size (in bytes) this file has transferred. Name transferred size uniqueIdentifier Description The unique identifier of the file transfer. Name id user Description The chat user this transfer is with. Name chat user Description Represents a file transfer with another chat user. Name file transfer PluralName file transfers Commands Connect Description Connect to the server. Name connect UnnamedArgument Description The connection to connect. Disconnect Description Disconnect from the server. Name disconnect UnnamedArgument Description The connection to disconnect. JoinChatRoom Arguments connection Description The connection to join on. Optional if the nearest enclosing tell block responds to this command. Name on Description Join a chat room. Name join chat room UnnamedArgument Description Chat room(s) to join. RefreshInformation Description Refresh various properties of a chat user. Name refresh information UnnamedArgument Description The chat user. ReloadPlugins Description Reloads all plugins that are in the search paths. Plugins that have been deleted or moved will be unloaded. Name reload plugins SendMessage Arguments action Description Send as an action? Name action tense echo Description Show the message locally on screen? (Defaults on.) Name local echo encoding Description The encoding to send the message as (will default to the room or connection encoding if omitted). Name encoded as target Description The chat user or chat room to send to. Optional if the nearest enclosing tell block responds to this command. Name to Description Send a message to a room or user. Name send message UnnamedArgument Description The message to send. (Plain text with HTML formatting. Must entity encode HTML special characters.) SendRawCommand Arguments connection Description The connection to send to. Optional if the nearest enclosing tell block responds to this command. Name to priority Description Send this command now? (This will bypass any queued commands.) Name priority Description Send raw server command (message) to server. Name send raw command UnnamedArgument Description The raw server command (message) to send. (This is protocol specific.) Description Classes and commands for Chat Core scripting. Chat Core is the the lowest level of Colloquy. Enumerations ConnectionStatus Connected Description Connected status. Name connected Connecting Description Connecting status. Name connecting Disconnected Description Disconnected status. Name disconnected Suspended Description Suspended status. Name suspended Encoding ASCII Name ASCII Big5 Name Big 5 Big5HKSCS Name Big 5 HKSCS GB18030 Name GB 18030 GBK Name GBK ISOLatin1 Name ISO Latin 1 ISOLatin2 Name ISO Latin 2 ISOLatin3 Name ISO Latin 3 ISOLatin4 Name ISO Latin 4 ISOLatin5 Name ISO Latin 5 ISOLatin9 Name ISO Latin 9 JapaneseEUC Name Japanese EUC KOI8R Name KOI8R KoreanEUC Name Korean EUC MacOSCyrllic Name Mac OS Cyrllic MacOSEuropean Name Mac OS European MacOSJapanese Name Mac OS Japanese MacOSKorean Name Mac OS Korean MacOSRoman Name Mac OS Roman MacOSSimpChinese Name Mac OS Simp. Chinese MacOSTradChinese Name Mac OS Trad. Chinese NonlossyASCII Name Nonlossy ASCII ShiftJIS Name Shift JIS SimpChineseEUC Name Simp. Chinese EUC TradChineseEUC Name Trad. Chinese EUC UTF8 Name UTF8 WindowsCyrllic Name Windows Cyrllic WindowsKorean Name Windows Korean WindowsLatin1 Name Windows Latin 1 WindowsLatin2 Name Windows Latin 2 WindowsSimpChinese Name Windows Simp. Chinese WindowsTradChinese Name Windows Trad. Chinese FileTransferStatus Done Name done Error Name error InProgress Name in progress Stopped Name stopped Waiting Name waiting FileTransferType Download Name download Upload Name upload Proxy None Description No proxy. Name none SOCKSFirewall Description SOCKS firewall proxy. Name SOCKS firewall SecureHTTP Description Secure HTTP proxy. Name secure HTTP SubcodeType Reply Description A subcode command reply. Name reply Request Description A subcode command request. Name request UserStatus Available Description Available status. Name available Away Description Away status. Name away Detached Description Detached status. Name detached Offline Description Offline status. Name offline Name Chat Core Suite