onchannel
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | onchannel [2006/08/29 16:08] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | # $EPIC: onchannel.txt, | ||
+ | ======Synopsis: | ||
+ | $__onchannel__() | ||
+ | $__onchannel__(< | ||
+ | $__onchannel__(< | ||
+ | |||
+ | ======Technical: | ||
+ | * There are two different actions provided by this function. | ||
+ | |||
+ | =====First Action (list of channel members): | ||
+ | * If no arguments are provided, the current window' | ||
+ | * If the first argument is a channel name or the literal asterisk (``*'' | ||
+ | * If you are not on the specified channel on the current server, the empty string is returned. | ||
+ | * On ircnet servers, anonymous channels (+a channel mode) won't give you a list of the channel members, and so you won't get anything useful out of this function. | ||
+ | * In general you can't use this function in the status bar. | ||
+ | * In ircII, this function is called $chanusers(). | ||
+ | |||
+ | =====Second Action (is this person on this channel? | ||
+ | * If the first argument is not a channel name, then it is considered to be a nickname. | ||
+ | * If you are not on the specified channel, the return value is 0. | ||
+ | * If the given nickname is not on the specified channel the return value is 0. | ||
+ | * Between the time you [[JOIN]] a channel and when /[[ON]] [[on channel_sync|CHANNEL_SYNC]] is thrown for that channel, the return value may be 0 or 1. | ||
+ | * In some versions of the server, the NAMES reply sent to the client when you join truncates the last nickname. | ||
+ | * In general you can't use this function in the status bar. | ||
+ | |||
+ | ======Practical: | ||
+ | |||
+ | ======Returns: | ||
+ | First action: A word list containing the members of the specified channel, | ||
+ | or the current channel. | ||
+ | circumstances where this may fail. | ||
+ | |||
+ | Second action: 1 if the specified user is on the specified channel, and 0 | ||
+ | if they are not. You must be on the channel. | ||
+ | server implementation may result in false negatives sometimes. | ||
+ | are some circumstances where this may fail. | ||
+ | |||
+ | ======Examples: | ||
+ | |||
+ | ======History: | ||
+ | The first action is the historical EPIC behavior and first appeared in | ||
+ | the " | ||
+ | is equivalent and first appeared around ircII-2.6. | ||
+ | $chanusers() was added to EPIC1. | ||
+ | |||
+ | The second action is the modern ircII behavior and first appeared around | ||
+ | ircII-2.3.24. | ||
onchannel.txt · Last modified: 2006/08/29 16:08 by 127.0.0.1