Semiconductor & Computer Engineering
From WikiChip
Difference between revisions of "mirc/commands/aline"
(→Example) |
|||
| (23 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{mirc title|/aline Command}} | ||
The '''aline command''' is used to add a single line of text to a custom window. This command is limited to custom @windows, If you need a more general command that is able to print to both custom windows, channel, and query consider using the /echo command instead. | The '''aline command''' is used to add a single line of text to a custom window. This command is limited to custom @windows, If you need a more general command that is able to print to both custom windows, channel, and query consider using the /echo command instead. | ||
| + | |||
'''Note:''' If the main window is sorted (text or listbox and /window -s has been used), lines added with /echo to that window won't be sorted, only lines added with /aline will. | '''Note:''' If the main window is sorted (text or listbox and /window -s has been used), lines added with /echo to that window won't be sorted, only lines added with /aline will. | ||
== Synopsis == | == Synopsis == | ||
| − | /aline - | + | /aline -scNahpinlt [c] <@name> <text> |
== Switches == | == Switches == | ||
* '''-s''' - Clears the old selection in a listbox and selects the newly added item | * '''-s''' - Clears the old selection in a listbox and selects the newly added item | ||
* '''-a''' - Selects the newly added item while keeping the old selection in a listbox | * '''-a''' - Selects the newly added item while keeping the old selection in a listbox | ||
| − | * '''-h''' - Highlights the window's node in the treebar | + | * '''-h''' - Highlights the window's node in the treebar/switchbar if the window is minimized |
* '''-p''' - Forces the line to be wrapped if it's too long to fit in on one line (does not apply to listboxes) | * '''-p''' - Forces the line to be wrapped if it's too long to fit in on one line (does not apply to listboxes) | ||
| − | * '''-i''' - Indent the newly added line (does not apply to listboxes) | + | * '''-i[N]''' - Indent the newly added line (does not apply to listboxes) by N spaces, default to 2 spaces |
| − | * '''-n''' - Prevent the line from being added if already exists | + | * '''-n''' - Prevent the line from being added if it already exists |
* '''-l''' - Specify the action to take place on the side-listbox | * '''-l''' - Specify the action to take place on the side-listbox | ||
| + | * '''-t''' - forces a re-wrap of all lines in a window that have not yet been wrapped to the current window size. | ||
| + | * '''-cN''' - Same as specifying the [c] parameter for the color of the line but via a switch | ||
== Parameters == | == Parameters == | ||
| − | * '''[c]''' - An optional color number for the line | + | * '''[c]''' - An optional color number for the line. |
| − | * '''<@name>''' - The name of the window | + | * '''<@name>''' - The name of the window. |
| − | * '''<text>''' - The text to be added | + | * '''<text>''' - The text to be added. |
== Example == | == Example == | ||
| − | <syntaxhighlight lang="mIRC"> | + | <syntaxhighlight lang="mIRC">alias example { |
;open a desktop custom window (main window is a listbox, no side-listbox and with an editbox) | ;open a desktop custom window (main window is a listbox, no side-listbox and with an editbox) | ||
| − | + | window -lde @Foo | |
;Add a line, line colored in yellow (8) | ;Add a line, line colored in yellow (8) | ||
| − | + | aline 8 @Foo Line A | |
;Add a line, color Dark Green (3), selected, clear old selection | ;Add a line, color Dark Green (3), selected, clear old selection | ||
| − | + | aline -s 3 @Foo Line B | |
}</syntaxhighlight> | }</syntaxhighlight> | ||
== Compatibility == | == Compatibility == | ||
| − | + | {{mIRC compatibility|5.0}} | |
| − | |||
| − | |||
| − | |||
| − | |||
== See also == | == See also == | ||
* [[List of commands - mIRC|List of commands]] | * [[List of commands - mIRC|List of commands]] | ||
* [[List of identifiers - mIRC|List of identifiers]] | * [[List of identifiers - mIRC|List of identifiers]] | ||
| − | * | + | * {{mIRC|$line}} |
| − | * | + | * {{mIRC|$fline}} |
| − | * | + | * {{mIRC|$sline}} |
| − | * | + | * {{mIRC|/cline}} |
| − | * | + | * {{mIRC|/dline}} |
| − | * | + | * {{mIRC|/echo}} |
| − | * | + | * {{mIRC|/iline}} |
| − | * | + | * {{mIRC|/rline}} |
| − | * | + | * {{mIRC|/sline}} |
| − | * | + | * {{mIRC|/window}} |
| + | {{mIRC command list}} | ||
| − | [[Category:mIRC commands]] | + | [[Category:mIRC commands|aline command - mIRC]] |
Latest revision as of 12:26, 29 October 2024
Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
The aline command is used to add a single line of text to a custom window. This command is limited to custom @windows, If you need a more general command that is able to print to both custom windows, channel, and query consider using the /echo command instead.
Note: If the main window is sorted (text or listbox and /window -s has been used), lines added with /echo to that window won't be sorted, only lines added with /aline will.
Synopsis[edit]
/aline -scNahpinlt [c] <@name> <text>
Switches[edit]
- -s - Clears the old selection in a listbox and selects the newly added item
- -a - Selects the newly added item while keeping the old selection in a listbox
- -h - Highlights the window's node in the treebar/switchbar if the window is minimized
- -p - Forces the line to be wrapped if it's too long to fit in on one line (does not apply to listboxes)
- -i[N] - Indent the newly added line (does not apply to listboxes) by N spaces, default to 2 spaces
- -n - Prevent the line from being added if it already exists
- -l - Specify the action to take place on the side-listbox
- -t - forces a re-wrap of all lines in a window that have not yet been wrapped to the current window size.
- -cN - Same as specifying the [c] parameter for the color of the line but via a switch
Parameters[edit]
- [c] - An optional color number for the line.
- <@name> - The name of the window.
- <text> - The text to be added.
Example[edit]
alias example { ;open a desktop custom window (main window is a listbox, no side-listbox and with an editbox) window -lde @Foo ;Add a line, line colored in yellow (8) aline 8 @Foo Line A ;Add a line, color Dark Green (3), selected, clear old selection aline -s 3 @Foo Line B }
Compatibility[edit]
Added: mIRC v5.0
Added on: 02 Apr 1997
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.
See also[edit]
- List of commands
- List of identifiers
- $line
- $fline
- $sline
- /cline
- /dline
- /echo
- /iline
- /rline
- /sline
- /window
mIRC commands list