Aliases

Aliases are simply custom commands or macros that you can define for Vortec. To create aliases, select the Alias option from the main menu. This Alias definition window will be displayed. In order to make use of aliases you must of course already be familiar with IRC and basic IRC commands.



You should NOT create an alias with the same name as an existing IRC command as Vortec always gives precedence to IRC commands over aliases. You may also use aliases within your popups and your events & controls.


The Alias Editor Window

Open the alias window by clicking the Alias button in the tool bar or select the Aliases option from the tools menu. The Alias editor is divided into 3 parts: the alias list that contains the names of all the aliases defined, the editor pane where you enter the alias commands and the control panel that has several buttons that allow you to save changes, load alias files etc.


You can right click on the alias list to display a popup menu that contains some additional commands, such as renaming aliases, and load/extracting Vortec scripts or PIL scripts .


You may also customize script code colors and editor options by right-clicking the editor window and selecting "Customize".


Defining Simple Aliases

The simplest aliases included only the aliases name followed by the command to be executed.

       Vortec: /join #Vortec        typing /Vortec will now allow you to join the channel #Vortec

       P:/part #                typing /p will allow you to leave the current channel


Variables

Vortec defines the following variables which can be used in your aliases definitions:


       $me                your nickname

       #                the current channel or nickname

       $#                the # symbol

       $1..$9                command line parameters

       *1..*9                sequential command lines parameters start with the number provided

       $+                trims extra space from between parameters

       $activewin        the name of the active window

       $apppath        the directory from which Vortec is running from

       $audience        the current channel or nickname (same as #)

       $day                the current day of the week

       $date                the current date according to your computer's internal calendar        

       $getpath        your default dcc download path

       $host                your local host name

       $ip                your local ip number

       $logpath        your log file directory

       $members        returns the number of people in a channel

       $netid                name of the network you're connected to

       $progpath        the directory from which Vortec is running from (same as $apppath)

       $sendpath        default dcc upload path

       $soundpath        default Sounds folder

       $server                the name of the server you are connected to

       $snick                currently selected nickname in a channel

       $time                the current time according to your computer's internal calendar

       $topic                topic string for the channel (only available for channel related aliases)

       $umode                your personal user mode

       $version        the version of Vortec which you are using

       $?="prompt"        Displays an input dialog box, returning the entered information


Special Variables/Funtions

$file "<prompt>" <filemask>

Pops up a file dialog allowing you to select a particular filename to use. You must specify a file type between quotation marks!


       Example: WAV:/sound # $file "select a file" c:\*.wav hope you like this sound



Common Aliases & Examples


Join Aliases


J:/join $# $+ $1

Joins a channel without having to enter the # symbol... ie /j Vortec will cause you to join #Vortec


HOP:/part # | /join #

Cause you to leave the current channel and rejoin it immediately


Sound Aliases


S:/sound # $1 *2

Plays a sound to the current channel (or nickname in a message window)


SND:/sound # $file "*.mid" *1

Allows you to pick a sound file from a file list and play it to the current channel/nick.


Operator Aliases


OPS: /opnotice # *1

Send a notice to all channel operators in the current channel.


Misc Aliases


N: /nick $?="Enter a new nickname"

Displays an input dialog box allowing you to change your nickname.


CHAT:/dcc chat $?="Enter a nickname to chat to"



Function Keys


You may also assign aliases to the Function keys (F2 - F12) by creating an alias with the key name. For example, to assign an alias to the F2 key, just create an alias named F2.


You may also use accelerator combinations as well. For CTRL key use C, for Shift use S, for Alt use A. Please note that these need to be in alphabetical order, with F as the last key. For example, to use CTRL+ALT+F2 use ACF2, not CAF2.


ACSF2                -        ALT+CTRL+SHIFT+F2

SF3                -        Shift+F3

etc...


This also works with the Escape key. You can name an alias ESC and have it execute when you press the ESC key. Accelerator keys are supported for ESC as well.


Windows System keyboard shortcuts cannot be overridden this way.


Copyright © 2009, John G. Kirkland

Created with the Freeware Edition of HelpNDoc: Free Web Help generator