Semiconductor & Computer Engineering
From WikiChip
Difference between revisions of "mirc/identifiers/$chan"
m (Bot: Adding a template (template:mIRC identifier list)) |
m (Bot: Fixing links) |
||
| Line 20: | Line 20: | ||
| '''hwnd''' || Returns the [[Operating system|operating system's]] actual [[hWnd|window handle]] for the channel. | | '''hwnd''' || Returns the [[Operating system|operating system's]] actual [[hWnd|window handle]] for the channel. | ||
|- | |- | ||
| − | | '''ial''' || Returns ''' | + | | '''ial''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if the [Internal address list - mIRC|IAL]] has been updated for the channel. |
|- | |- | ||
| − | | '''ibl''' || Returns ''' | + | | '''ibl''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if the [[Internal ban list - mIRC|IBL]] has been updated for the channel |
|- | |- | ||
| '''idle''' || Returns the amount of time the channel has been idle. This does not include entries made from the local mIRC client. | | '''idle''' || Returns the amount of time the channel has been idle. This does not include entries made from the local mIRC client. | ||
|- | |- | ||
| − | | '''iel''' || Returns ''' | + | | '''iel''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if the local mIRC client is on the channel's internal exempt list. |
|- | |- | ||
| − | | '''iil''' || Returns ''' | + | | '''iil''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if local mIRC client is on the channel's internal invite list. |
|- | |- | ||
| − | | '''inwho''' || Returns ''' | + | | '''inwho''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if a [[/who command - mIRC|/who command]] has been performed on the channel, and the results are still being processed. |
|- | |- | ||
| '''key''' || Returns the channel's key. | | '''key''' || Returns the channel's key. | ||
| Line 40: | Line 40: | ||
| '''mode''' || Returns the current modes set in the channel. | | '''mode''' || Returns the current modes set in the channel. | ||
|- | |- | ||
| − | | '''stamp''' || Returns ''' | + | | '''stamp''' || Returns '''{{mIRC|$true}}''' or '''{{mIRC|$false}}''' if [[time stamping - mIRC|time stamping]] is enabled on the channel. |
|- | |- | ||
| '''status''' || Returns: '''joining''', '''joined''', or '''kicked'''. | | '''status''' || Returns: '''joining''', '''joined''', or '''kicked'''. | ||
| Line 81: | Line 81: | ||
* [[On join - mIRC|ON JOIN]] | * [[On join - mIRC|ON JOIN]] | ||
* [[On part - mIRC|ON PART]] | * [[On part - mIRC|ON PART]] | ||
| − | * | + | * {{mIRC|$ial}} |
| − | * | + | * {{mIRC|$ibl}} |
| − | * | + | * {{mIRC|$nick}} |
{{mIRC identifier list}} | {{mIRC identifier list}} | ||
[[Category:MIRC identifiers]] | [[Category:MIRC identifiers]] | ||
Revision as of 19:51, 5 July 2014
The $chan identifier is filled during events which trigger on a channel.
The $chan identifier can also be used to get information regarding a specific channel the local mIRC client is in.
Synopsis
$chan[(#/N).property]
Parameters
(#/N)The specific channel, or channel number referencing the channel.
.propertyGet the results of a specific property request for the specified channel or N.
Properties
| Property | Description |
|---|---|
| cid | Returns the connection ID for the channel. |
| hwnd | Returns the operating system's actual window handle for the channel. |
| ial | Returns $true or $false if the [Internal address list - mIRC|IAL]] has been updated for the channel. |
| ibl | Returns $true or $false if the IBL has been updated for the channel |
| idle | Returns the amount of time the channel has been idle. This does not include entries made from the local mIRC client. |
| iel | Returns $true or $false if the local mIRC client is on the channel's internal exempt list. |
| iil | Returns $true or $false if local mIRC client is on the channel's internal invite list. |
| inwho | Returns $true or $false if a /who command has been performed on the channel, and the results are still being processed. |
| key | Returns the channel's key. |
| limit | Returns the amount of users the channel is limited to. |
| logfile | Returns the location of the current channel's log file, if any. |
| mode | Returns the current modes set in the channel. |
| stamp | Returns $true or $false if time stamping is enabled on the channel. |
| status | Returns: joining, joined, or kicked. |
| topic | Returns the channel topic. |
| wid | Returns the mIRC application's window id for the channel window. |
Examples
Create an alias that opens a custom @window which loads some basic information about the active channel:
alias getDetails { if ($active ischan) { var %c = $active window @getDetails 350 350 650 200 clear @getDetails echo @getDetails Channel: %c echo @getDetails $crlf $crlf echo @getDetails Topic: $chan(%c).topic echo @getDetails $crlf $crlf echo @getDetails Modes: $chan(%c).mode echo @getDetails $crlf $crlf echo @getDetails Key: $iif($chan(%c).key,$v1,No key set) } }
This custom alias can now be executed using the following command in a channel command-line:
/getDetails
The results of this command will look similar to the results below:
Compatibility
Added: mIRC v4.7
Added On: 09/12/96
See Also
mIRC identifier list