Xirc Scripting Reference
Introduction
Commands Events

Functions
All

 

$ARRAY
Creates and init an array variable
$ASCII
Returns the ascii code for the specified character
$ASCIITOBASE64
Encodes an ascii string to base64 string
$AWAY
Returns 1 if you are away on current server
$B
Returns the BOLD mIRC style character
$BASE64TOASCII
Returns a decoded base64 string
$CHAN.AWAYCOUNT
Returns the number of away users in a channel (Plugin Channel)
$CHAN.BANCOUNT
Returns the number of ban masks in the channel (Plugin Channel)
$CHAN.BANLIST
Returns an array of channel ban masks (Plugin Channel)
$CHAN.ISADMIN
Checks if the given user is a chan admin on a channel (Plugin Channel)
$CHAN.ISHALFOP
Checks if the given user is an halfop on a channel (Plugin Channel)
$CHAN.ISMEOP
Checks if you are chanop on a channel (Plugin Channel)
$CHAN.ISOWNER
Checks if an user is chan owner on a channel (Plugin Channel)
$CHAN.ISON
Checks if an user is on a channel (Plugin Channel)
$CHAN.ISOP
Checks if an user is a chanop on a channel (Plugin Channel)
$CHAN.ISUSEROP
Checks if an user is userop on a channel (Plugin Channel)
$CHAN.ISVOICE
Checks if an user is voiced (+v) on a channel (Plugin Channel)
$CHAN.KEY
Returns the key of a channel (Plugin Channel)
$CHAN.LASTMESSAGE
Returns the last message sent on a channel (Plugin Channel)
$CHAN.LIMIT
Returns the limit on a channel (Plugin Channel)
$CHAN.LOGNAME
Returns the log file path of a channel (Plugin Channel)
$CHAN.MATCHBAN
Matches a mask agains the channel ban list (Plugin Channel)
$CHAN.MODE
Returns the mode string of a channel (Plugin Channel)
$CHAN.NAME
Returns the name of a channel (Plugin Channel)
$CHAN.OPCOUNT
Returns the number of channel operator of a channel (Plugin Channel)
$CHAN.TOPIC
Returns the topic of a channel (Plugin Channel)
$CHAN.TOPICBY
Returns the author of the topic of a channel (Plugin Channel)
$CHAN.TOPICDATE
Returns the set time of the topic of a channel (Plugin Channel)
$CHAN.USER
Returns an array of attributes of an user of a channel (Plugin Channel)
$CHAN.USERCOUNT
Returns the number of users of a channel (Plugin Channel)
$CHAN.USERLIST
Returns an array of users of a channel (Plugin Channel)
$CHAN.VOICECOUNT
Returns the number of voiced users of channel (Plugin Channel)
$CHANNEL
Retrieves the context id of a specified channel
$CHAR
Returns a character specified by ascii code
$CONFIG.FILELIST
Returns a list of open config files (Plugin Config)
$CONFIG.FILENAME
Returns the filename of an open config file (Plugin Config)
$CONFIG.HASSECTION
Checks if a section is present in a config file (Plugin Config)
$CONFIG.ID
Returns the id of an open config file (Plugin Config)
$CONFIG.KEYLIST
Returns an array of keys in a config file (Plugin Config)
$CONFIG.OPEN
Opens a config file (Plugin Config)
$CONFIG.READ
Reads an entry from a config file (Plugin Config)
$CONFIG.READONLY
Checks if a config file is opened in readonly mode (Plugin Config)
$CONFIG.SECTION
Returns the name of the current section of a config file (Plugin Config)
$CONFIG.SECTIONLIST
Returns an array of sections in a config file (Plugin Config)
$CONTEXT
Retrieves the ID of the specified IRC context
$CONSOLE
Retrieves the context ID of a specified console
$CR
Returns a carriage return character
$CURRENT
Returns the id of the current context (server/channel/query)
$DCC.LIST
Returns an array containing all active dcc session
$DEFAULT
Returns the value of an option
$FILE.CLOSE
Close a previously opened file (Plugin File)
$FILE.DIRCONTENTS
Returns an array containing all files and directories names for the specified path (Plugin File)
$FILE.EOF
Returns 1 if the end-of-file is reached for the specified file (Plugin File)
$FILE.EXTRACTPATH
Returns the path by deleting the last path component of the given path (Plugin File)
$FILE.EXTRACTFILENAME
Returns the last path component of the given path (Plugin File)
$FILE.EXISTS
Returns 1 if the given file exists (Plugin File)
$FILE.ISDIR
Returns 1 if the specified path is a directory (Plugin File)
$FILE.OFFSET
Returns the current file offset of the specified file (Plugin File)
$FILE.OPEN
Opens/creates a file for reading, appending or writing (Plugin File)
$FILE.OPENPANEL
Opens the standard load panel (Plugin File)
$FILE.READ
Reads the given number of characters from a file (Plugin File)
$FILE.READLINE
Reads from the current file position until the CR/LF or LF character is encountered (Plugin File)
$FILE.SAVEPANEL
Opens the standard save panel (Plugin File)
$FILE.SEEK
Changes the access position for an open file (Plugin File)
$FILE.SIZE
Returns the size in bytes of the specified file at path (Plugin File)
$FILE.TRUNCATE
Truncates a file at offset (Plugin File)
$FILE.WRITE
Writes a string or characters to a specified file (Plugin File)
$HOMEDIR
Returns the MacOSX home directory of the current user
$HOSTPART
Returns the host "part" of the specified irc address
$K
Returns the "color" mIRC control character
$LF
Returns a newline character
$MASK
Retrieves the host mask of a user
$ME
Returns the nickname of the current IRC server
$NICKPART
Returns the nick part of an IRC address
$O
Returns the "reset" mIRC control character
$QUERY
Retrieves the context id of a specified query
$R
Returns the "reverse" mIRC control character
$RAND
Generates a random number
$SELECTED
Returns an array of selected nicknames in the specified channel
$SERVER.AWAYMESSAGE
Returns the "away" message of a server (Plugin Server)
$SERVER.CHANNEL
Returns the id of the channel name of a server (Plugin Server)
$SERVER.CHANNELCOUNT
Returns the number of channels in the specified server (Plugin Server)
$SERVER.CHANNELLIST
Returns an array of channel names in a server (Plugin Server)
$SERVER.DISPLAYNAME
Returns the connection name of a server (Plugin Server)
$SERVER.IRCSERVER
Returns the address of an IRC server (Plugin Server)
$SERVER.ISCONNECTED
Returns 1 if the server is connected (Plugin Server)
$SERVER.ISIGNORED
Returns 1 if the specified user is ignored in a server (Plugin Server)
$SERVER.ISREGISTERED
Returns 1 if the connection is registered on a server (Plugin Server)
$SERVER.LOGNAME
Returns the current log name of a server (Plugin Server)
$SERVER.NICK
Returns the nickname of a server (Plugin Server)
$SERVER.REALNAME
Returns the real name used in the specified server (Plugin Server)
$SERVER
Returns the id of a specified server
$SETDEFAULT
Set the value of the specified option
$STR.APPEND
Append one string to another (Plugin String)
$STR.CAPITALIZE
Returns a string with the first character from each word in the receiver changed to its corresponding uppercase value (Plugin String)
$STR.CMP
Compares two string, case sensitive (Plugin String)
$STR.CMPNOCASE
Compares two string, case insensitive (Plugin String)
$STR.CONTAINS
Returns 1 if the first string contains the second string, case sensitive (Plugin String)
$STR.CONTAINSNOCASE
Returns 1 if the first string contains the second string, case insensitive (Plugin String)
$STR.EQUAL
Returns 1 if the first string is equal to the second string, case sensitive (Plugin String)
$STR.EQUALNOCASE
Returns 1 if the first string is equal to the second string, case insensitive (Plugin String)
$STR.FIND
Find the index of the nth ocurrence of a substring in a string (Plugin String)
$STR.FINDFIRST
Find the index of a substring in a string, case sensitive (Plugin String)
$STR.FINDFIRSTNOCASE
Find the index of a substring in a string, case insensitive (Plugin String)
$STR.FINDLAST
Find the last index of a substring in a string, case sensitive (Plugin String)
$STR.FINDLASTONOCASE
Find the last index of a substring in a string, case insensitive (Plugin String)
$STR.INSERT
Inserts a string in a string at a given index (Plugin String)
$STR.ISEMPTY
Returns 1 if the string is empty (Plugin String)
$STR.ISNUMBER
Returns 1 if the string represents a number (Plugin String)
$STR.LEFT
Returns a substring starting from the left until the given index (Plugin String)
$STR.LEFTTOFIRST
Returns the left part of a string until a given string (Plugin String)
$STR.LEFTTOLAST
Returns the left part of a string until the last ocurrence of a given substring (Plugin String)
$STR.LEN
Returns the length of the specified string (Plugin String)
$STR.LOWERCASE
Returns a string with each character from the receiver changed to its corresponding lowercase value (Plugin String)
$STR.MATCH
Matches a fixed string agains a wildcard expression, case sensitive (Plugin String)
$STR.MATCHNOCASE
Matches a fixed string agains a wildcard expression, case insensitive (Plugin String)
$STR.MID
Returns a substring starting from a given index (Plugin String)
$STR.PADDING
Grows or shrinks a string by either removing characters from the end, or by appending as many occurrences of pad string as necessary (Plugin String)
$STR.PREPEND
Prepend one string to another (Plugin String)
$STR.REPLACE
Replaces all occurences of a string with a string, case sensitive (Plugin String)
$STR.REPLACENOCASE
Replaces all occurences of a string with a string, case insensitive (Plugin String)
$STR.RIGHT
Returns a substring starting from the right until the given index (Plugin String)
$STR.RIGHTFROMFIRST
Returns the right part of a string from the first ocurrence of a given substring (Plugin String)
$STR.RIGHTFROMLAST
Returns the right part of a string from the last ocurrence of a given substring (Plugin String)
$STR.SPLIT
Splits a string to an array (Plugin String)
$STR.STRIP
Returns a whitespace stripped string (Plugin String)
$STR.STRIPLEFT
Returns a left whitespace stripped string (Plugin String)
$STR.STRIPRIGHT
Returns a right whitespace stripped string (Plugin String)
$STR.TOKEN
Returns the nth token in a string (Plugin String)
$STR.UPPERCASE
Returns a string with each character from the receiver changed to its corresponding uppercase value (Plugin String)
$STR.WORD
Returns the nth word in a string (Plugin Server)
$TARGET
Returns the target of the current context
$TEMPDIR
Returns the absolute path of the temporary directory
$TIME
Returns a time/date string
$U
Returns the "underline" mIRC control character
$USERPART
Returns the user part of a irc address
$UNIXTIME
Returns the current the time in seconds from the reference date 1 January 1970
$WINDOW
Retrieves the id of a window context
$WINDOW.OPEN
Creates and opens a new window
$XIRCDIR
Get the current Xirc local directory
$?
Brings up an input panel


© 2004-2005 Gian Luca Cannata. All Rights Reserved. (Last updated: 2004-12-20)