Functions: All

$ a b c d e f g h i j k l m
n o p q r s t u w v x y z All
$$ Retrieves the ID of the current object
$active Retrieves the window ID of the active window
$array Explicitly creates an array
$ascii Returns the ASCII code of a character
$avatar.name Returns the avatar name for the specified user
$avatar.path Returns the avatar path for the specified user
$avatar Obsolete
$away Returns 1 if the current user is away
$b Returns the BOLD mIRC control character
$base64ToAscii Returns a decoded base64 string
$calc $calc() has been replaced by $() !
$chan.admincount Returns the number of channel admin users on a channel
$chan.bancount Returns the number of entries in the channel ban list
$chan.banexceptioncount Returns the number of entries in the channel ban exception list
$chan.banexceptionlist Returns an array of channel ban exception masks
$chan.banlist Returns an array of channel ban masks
$chan.getflag Returns the channel-user mode flag of an user
$chan.halfopcount Returns the number of halfop users on a channel
$chan.invitecount Returns the number of entries in the channel invite list
$chan.invitelist Returns an array of channel invite masks
$chan.isDead Checks if a channel is dead
$chan.isMeAdmin Checks if the current user is at least an administrator on a channel
$chan.isMeHalfOp Checks if the current user is at least an half operator on a channel
$chan.isMeOp Checks if the current user is at least op on a channel
$chan.isMeOwner Checks if the current user is at least an owner on a channel
$chan.isMeUserOp Checks if the current user is at least an user operator on a channel
$chan.isMeVoice Checks if the current user is at least voice on a channel
$chan.isadmin Checks if an user is at least channel administrator
$chan.ishalfop Checks if an user is at least halfop on a channel
$chan.ison Checks if an user is on a channel
$chan.isop Checks if an user is at least an op on a channel
$chan.isowner Checks if an user is at least a channel owner
$chan.isuserop Checks if an user is at least an userop on a channel
$chan.isvoice Checks if an user is at least voiced on a channel
$chan.key Returns the key of a channel
$chan.limit Returns the limit of a channel
$chan.matchban Matches a mask agains the channel ban list
$chan.matchbanexception Matches a mask agains the channel ban exception list
$chan.matchinvite Matches a mask agains the channel invite list
$chan.mode Returns the mode string of a channel
$chan.name Returns the name of a channel
$chan.opcount Returns the number of op users on a channel
$chan.ownercount Returns the number of channel owner users on a channel
$chan.topic Returns the topic of a channel
$chan.topicsetat Returns the set time of the topic of a channel
$chan.topicsetby Returns the author of the topic of a channel
$chan.userJoinTime Returns the time that an user has joined the channel
$chan.userLastActionTime Returns the time that an user has last performed some kind of action on the channel
$chan.usercount Returns the number of users on a channel
$chan.usermodelevel Returns the channel user-mode level
$chan.useropcount Returns the number of userop users on a channel
$chan.users Returns an array of channel user nicknames
$chan.voicecount Returns the number of voiced users on a channel
$channel Retrieves the window ID of a specified channel
$char Returns a character specified by ascii code
$classdefined Checks if a class is defined
$config.filelist Returns a list of open config files
$config.filename Returns the filename of an open config file
$config.hassection Checks wheter a section is present in a config file
$config.id Returns the id of an open config file
$config.keylist Returns a list of keys in a config file
$config.open Opens a config file
$config.read Reads an entry from a config file
$config.readonly Checks wheter a config file is opened in readonly mode
$config.section Returns the name of the current section of a config file
$config.sectionlist Returns a list of the sections in a config file
$console Retrieves the window ID of a specified console
$context Retrieves the ID of the specified IRC context
$cr Returns a carriage return character
$date Returns a date/time string using a specified format
$dcc.averageSpeed Returns the average speed of a dcc file transfer
$dcc.connectionType Returns the connection type of the specified DCC
$dcc.ircContext Returns the ircContext from which this DCC has originated
$dcc.isFileDownload Checks if a DCC is a download file transfer
$dcc.isFileTransfer Checks if a DCC is a file transfer
$dcc.isFileUpload Checks if a DCC is an upload file transfer
$dcc.localFileName Returns the local file name associated to the specified DCC
$dcc.localFileSize Returns the local file size associated to the specified DCC
$dcc.localHost Returns the local hostname associated to the specified DCC
$dcc.localIp Returns the local ip address associated to the specified DCC
$dcc.localNick Returns the local nickname associated to the specified DCC
$dcc.localPort Returns the local port associated to the specified DCC
$dcc.localUser Returns the local username associated to the specified DCC
$dcc.protocol Returns the protocol of the specified DCC
$dcc.remoteFileName Returns the remote file name associated to the specified DCC
$dcc.remoteFileSize Returns the remote file size associated to the specified DCC
$dcc.remoteHost Returns the remote hostname associated to the specified DCC
$dcc.remoteIp Returns the remote ip address associated to the specified DCC
$dcc.remoteNick Returns the remote nickname associated to the specified DCC
$dcc.remotePort Returns the remote port associated to the specified DCC
$dcc.remoteUser Returns the remote username associated to the specified DCC
$dcc.session Returns the DCC session identifier associated to a window
$dcc.transferredBytes Returns the number of transferred bytes in a dcc file transfer
$dockwidget.isVisible Returns the state of the dock widget
$features Returns the features that KVIrc supports
$file.currentdir Get the current directory
$file.exists Check if a file exists
$file.extractfilename Extract the filename from a file path
$file.extractpath Extract the path from a filename
$file.fixpath Converts file paths
$file.globaldir Get the KVIrc global directory
$file.homedir Get the user's HOME directory
$file.localdir Get the KVIrc local directory
$file.ls Returns a directory listing
$file.ps Returns the file path separator
$file.read Reads a text file
$file.rootdir Get the system root directory
$file.size Returns the size of a file
$file.type Checks the type of a path
$fmtsocket Returns a formatted socket buffer
$hexToAscii Returns a decoded hex string
$hostname Returns the hostname of the specified user
$ic Retrieves the ID of the specified IRC context
$icon Returns the ID of an icon
$iconname Returns the name of an icon
$isMainWindowMinimized Checks if main KVirc window is minimized
$isMeHalfOp Returns 1 if the current user has halfop status
$isMeOp Returns 1 if the current user has operator status
$isMeUserOp Returns 1 if the current user has userop status
$isMeVoice Returns 1 if the current user has voice status
$isTimer Checks for a timer existence
$isWellKnown Returns 1 if the specified user is well known
$k Returns the COLOR mIRC control character
$lag.lag Returns the lag on the current server
$lf Returns a line feed character
$log.file Returns the current log filename
$mask.hasNumericHost Checks if a host part of a mask is numeric
$mask.host Returns the hostname part of an IRC mask
$mask.match Matches a mask agains a wildcarded one
$mask.nick Returns the nick part of an IRC mask
$mask.user Returns the username part of an IRC mask
$mask Retrieves the host mask of a user
$me Returns the current nickname
$mp3player.getchannels Returns the number of channels of the current song (mp3player module)
$mp3player.getfilename Returns the filename of the current song (mp3player module)
$mp3player.getfreq Returns the frequency of the current song (mp3player module)
$mp3player.getlength Returns the length of the current song (mp3player module)
$mp3player.getmp3tag_album reads album entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_artist reads artist entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_comment reads comment entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_copright reads copright entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_crc reads crc entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_date reads year entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_emphasis reads emphasis entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_genre reads genre entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_layer reads mpeg layer entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_original reads original entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_title reads title entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_tracknumber reads tracknumber entry from mp3 tag (mp3player module)
$mp3player.getmp3tag_version reads mpeg version from mp3 tag (mp3player module)
$mp3player.getposition Returns the position of the current song (mp3player module)
$mp3player.getrate Returns the rate of the current song (mp3player module)
$mp3player.gettime Returns the time of the current song (mp3player module)
$mp3player.gettitle Returns the title of the current song (mp3player module)
$mp3player.ispaused Checks the state of the mp3 player (mp3player module)
$mp3player.isplaying Checks the state of the mp3 player (mp3player module)
$msgtype Returns the id of a message type color set
$my.host Returns the current hostname
$my.ip Returns the current ip address
$my.network Returns the current network name
$my.nick Returns the current nickname
$my.server Returns the current server name
$my.umode Returns the current user mode flags
$my.user Returns the current username
$new Creates a new object
$notifier.isEnabled Returns 1 if the notifier window is enabled
$o Returns the RESET mIRC control character
$option Returns the value of an option
$options.isdialog Returns the options dialog state
$perl.isAvailable Check if perl scripting support is available
$query Retrieves the window ID of a specified query
$r Returns the REVERSE mIRC control character
$rand Generates a random number
$regchan.find Checks if a channel is registered
$regchan.match Checks if a channel is registered
$regchan.property Returns a property of an entry in the registered channels database
$reguser.exactMatch Returns an entry in the registered user database
$reguser.list Get a list of registered user masks
$reguser.mask Returns the registration masks for a db entry
$reguser.match Returns an entry in the registered user database
$reguser.matchProperty Returns a property of an entry in the registered user database
$reguser.property Returns a property of an entry in the registered user database
$selected Returns the list of selected nicknames in the channel
$server Returns the current server name (if any)
$split Splits a string to an array
$str.append Append one string to another.
$str.charsum Returns the sum of the character codes of the string
$str.cmp Compare two strings alphabetically
$str.cmpnocase Compare two strings alphabetically, case insensitive.
$str.contains Returns 1 if the first parameter contains the second
$str.containsnocase Returns 1 if the first parameter contains the second, case insensitive
$str.equal Returns 1 if the two string parameters are equal
$str.equalnocase Returns 1 if the two string parameters are equal, case insensitive
$str.find Find the index of the nth ocurrence of a substring in a string
$str.findfirst Find the index of a substring in a string
$str.findfirstnocase Find the index of a substring in a string, case insensitive
$str.findlast Find the last index of a substring in a string
$str.findlastnocase Find the last index of a substring in a string, case insensitive
$str.insert Inserts a substring in a string at a given index
$str.isempty Returns 1 if the given string don't have any character.
$str.isnumber Returns 1 if the given string represents a number
$str.isunsignednumber Returns 1 if the given string represents an unsigned number
$str.left Returns a substring starting from the left until the given index.
$str.lefttofirst     Returns the left part of a string until a given substring
$str.lefttolast     Returns the left part of a string until the last ocurrence of a given substring
$str.len Returns the lenght of the given string
$str.lowcase Returns the given string with all characters turned to lower case
$str.match Matches a fixed string agains a wildcard expression
$str.matchnocase Matches a fixed string agains a wildcard expression (case insensitive)
$str.mid Returns a substring starting from a given index.
$str.prepend Prepend one string to another.
$str.replace Append one string to another.
$str.replacenocase Append one string to another.
$str.right Returns a substring starting from the right until the given index.
$str.rightfromfirst     Returns the right part of a string from the first ocurrence of a given substring
$str.rightfromlast     Returns the right part of a string from the last ocurrence of a given substring
$str.strip Returns a whitespace stripped string
$str.stripleft Returns a left whitespace stripped string
$str.stripright Returns a right whitespace stripped string
$str.token Returns the nth token in a string
$str.upcase Returns the given string with all characters turned to upper case
$str.word Returns the nth word in a string
$sw Returns the value of a switch for an alias
$system.dcop Performs a DCOP call
$system.getenv Returns the value of an enviroinement variable
$system.hostname Returns the hostname of the machine that KVIrc is running on
$system.osmachine Returns the machine of the operating system
$system.osname Returns the name of the operating system
$system.osnodename Returns the nodename of the operating system
$system.osrelease Returns the release of the operating system
$system.ostype Returns the type of the operating system
$system.osversion Returns the version of the operating system
$target Returns the target of the current window
$this Retrieves the ID of the current object
$time Returns a formatted date/time string
$tmphighlight.ishighlighted Returns 1 if the user is highlighted on this channel, 0 otherwise
$toolbar.exists Checks if a toolbar exists
$toolbar.isVisible Checks if a toolbar is visible
$toolbar.items Returns the list of items in a specified toolbar
$toolbar.list Returns a list of defined toolbars
$tr Translates an english string to the current language
$u Returns the UNDERLINE mIRC control character
$unixTime Returns the current UNIX time
$username Returns the username of the specified user
$version Returns informations about the version of KVIrc.
$window.activityLevel Returns the current activity level of a window
$window.activityTemperature Returns the current activity temperature of a window
$window.caption Returns the caption of a window
$window.console Returns the console that a window is attacched to
$window.exists Checks for the existence of a window
$window.hasInput Checks if a window has an input field
$window.hasOutput Checks if a window has a text output widget
$window.hasUserFocus Checks if a window has the user focus
$window.isMaximized Checks if a window is currently maximized
$window.isMinimized Checks if a window is currently minimized
$window.list Generates lists of windows
$window.open Creates and opens a new window
$window.type Returns the type of a window
$window Retrieves the ID of a specified window
$ a b c d e f g h i j k l m
n o p q r s t u w v x y z All

KVIrc 3.2.0 Documentation
Generated by kris at Sun Dec 2 00:00:57 2007