Modules:Misc:InternalEventList
From Anope Wiki
Internal events can be used to hooked to events happening inside the Anope core. For more information on how to make your module use internal events, take a look at Modules:QuickList:InternalEvents.
Note that internal events are usually emitted after the action has been performed (unless noted otherwise), so any deleted channel/user/bot/etc will already be deleted and any new channel/user/bot/etc will already be there.
The arguments are given as av[0] - av[n]. This are references to the argv/av argument in the callback function. The argc/ac argument will be n + 1, so if the last given argument is av[2], ac will be 3.
EVENT_ACCESS_ADD
A user has been added to a channel access list.
| av[0] | Name of the channel the user has been added to |
| av[1] | The nickname of the user that has just added an entry to the access list |
| av[2] | The nickname of the user that has been added to the access list |
| av[3] | The level number the user has been added with |
EVENT_ACCESS_CHANGE
A user level has been changed on a channel access list.
| av[0] | Name of the channel the access list has been modified of |
| av[1] | The nickname of the user that has just modified the access list of the channel |
| av[2] | The nickname of the user whose access level has just been modified |
| av[3] | The new access level for the user |
EVENT_ACCESS_CLEAR
A channel access list has been cleared
| av[0] | Name of the channel the access list has been cleared of |
| av[1] | The nickname of the user that has cleared the access list |
EVENT_ACCESS_DEL
A user has been deleted from a channel access list.
| av[0] | Name of the channel the access entry has been deleted of |
| av[1] | The nickname of the user that has deleted the access entry |
| av[2] | The nickname of the user whose access level has just been removed |
EVENT_BOT_ASSIGN
A BotServ bot has been assigned to a channel.
| av[0] | Name of the channel the bot has been assigned to |
| av[1] | The nickname of the bot that has been assigned to the channel |
EVENT_BOT_BAN
A BotServ bot has banned a user, e.g. badword kick reached the ttb.
| av[0] | The nick of the user banned. |
| av[1] | The Channel the user was banned from. |
| av[2] | The mask that was banned. |
EVENT_BOT_CHANGE
The properties of a BotServ bot have been changed.
| av[0] | The nickname of the bot involved |
EVENT_BOT_CREATE
A new BotServ bot has been created, and is ready to use.
| av[0] | The nickname of the newly created bot |
EVENT_BOT_DEL
A BotServ bot is being deleted from BotServ. This event is being sent just before the actual deletion is performed.
| av[0] | The nickname of the bot being deleted |
EVENT_BOT_FANTASY
A fantasy command of the bot has been triggered. This event should be used to create your own fantasy commands.
| av[0] | The fantasy command that has been triggered without leading '!' |
| av[1] | The nickname of the user that has triggered the fantasy command |
| av[2] | The name of the channel the fantasy command has been triggered on |
| av[3] | Contains any optional paramenters passed after the fantasy command. If none are present, this will not exist, and argc will will be 3 |
EVENT_BOT_FANTASY_NO_ACCESS
A fantasy command of the bot has been triggered by someone without access to BotServ FANTASY commands on the channel. This will NOT trigger if someone with access has triggered a fantasy command; use EVENT_BOT_FANTASY for those. Hook to both events to catch both event triggers.
| av[0] | The fantasy command that has been triggered without leading '!' |
| av[1] | The nickname of the user that has triggered the fantasy command |
| av[2] | The name of the channel the fantasy command has been triggered on |
| av[3] | Contains any optional paramenters passed after the fantasy command. If none are present, this will not exist, and argc will will be 3 |
EVENT_BOT_JOIN
A BotServ bot has joined a channel and opped itself.
| av[0] | The name of the channel the bot has just joined |
| av[1] | The nickname of the bot that has joined the channel |
EVENT_BOT_KICK
A BotServ bot has kicked a user from a channel.
| av[0] | The name of the user that has been kicked. |
| av[1] | The name of the channel the user was kicked from. |
| av[2] | The reason for the kick. |
EVENT_BOT_UNASSIGN
A BotServ bot is being unassigned from a channel. This event is being sent before the actual removing of the bot is done.
| av[0] | The name of the channel the bot has been unassigned from |
| av[1] | The nickname of the bot that has been unassigned |
EVENT_CHAN_DROP
A channel has been dropped and deleted.
| av[0] | The name of the channel that has been dropped |
EVENT_CHAN_EXPIRE
A channel has been expired and will be deleted. The event will be emitted just before the actual channel deletion happens.
| av[0] | The name of the channel that has been expired |
EVENT_CHAN_FORBIDDEN
A channel has been forbidden (ChanServ FORBID).
| av[0] | The name of the channel that has been forbidden |
EVENT_CHAN_KICK
Someone has been kicked from a channel. This event is emitted before the user is removed from the internal channels' userlist.
| av[0] | The nick of the user that has been kicked |
| av[1] | The channel the user has been kicked from |
EVENT_CHAN_REGISTERED
A new channel has been registered.
| av[0] | The name of the channel that has been registered |
EVENT_CHAN_SUSPENDED
A channel has been suspended (ChanServ SUSPEND).
| av[0] | The name of the channel that has been suspended |
EVENT_CHAN_UNSUSPEND
A channel has been unsuspended (ChanServ UNSUSPEND).
| av[0] | The name of the channel that has been unsuspended |
EVENT_CHANGE_NICK
A user has just changed it's nick.
| av[0] | The new nickname of the user |
EVENT_CONNECT
This event is emitted when the connection to our uplink hub is being made.
| av[0] | EVENT_START or EVENT_STOP, to indicate if it's emitted before or after the connection has been made. EVENT_STOP is emitted before our burst is being sent over the link |
EVENT_DB_EXPIRE
This event is emitted when the expiry routines for all things that can expire in Anope are being run.
| av[0] | EVENT_START or EVENT_STOP, to indicate if it's being emitted before or after the expiry routines have been run |
EVENT_DB_SAVING
This event is emitted when the databases are being saved.
| av[0] | EVENT_START or EVENT_STOP, to indicate if it's being emitted before or after saving routines have been run |
EVENT_DB_BACKUP
This event is emitted when the databases are backed up.
| av[0] | EVENT_START when the backup commences, and EVENT_STOP when it finishes |
EVENT_DEFCON_LEVEL
The DefCon level has just been changed. This event is emitted before any DefCon-related action is taken. The internal DefConLevel has already been raised at this point.
| av[0] | The new level of DefCon being invoked |
EVENT_GROUP
A user has grouped it's nickname to another user group.
| av[0] | The nickname of the user that joined the group |
EVENT_JOIN_CHANNEL
A user joins a channel.
| av[0] | EVENT_START or EVENT_STOP. EVENT_START when the user has passed all access checks and is allowed to join, but has not yet joined the channel. EVENT_STOP when the user has joined and all needed modes are set etc |
| av[1] | The nickname of the user joining the channel |
| av[2] | The name of the channel the user has joined |
EVENT_NEWNICK
A new user has been introduced on the network.
| av[0] | The nickname of the newly introduced user |
EVENT_NICK_DROPPED
A user's nick has just been dropped. Note that the nickname information has already been deleted!
| av[0] | The nickname of the user that has just been dropped |
EVENT_NICK_EXPIRE
A user's nick has just expired. Note that, as with EVENT_NICK_DROPPED, the nickname information has already been deleted!
| av[0] | The nickname of the user that has just expired |
EVENT_NICK_FORBIDDEN
A user's nick has just been forbidden.
| av[0] | The nickname that has just been forbidden |
EVENT_NICK_IDENTIFY
A user has just identified for it's nickname with NickServ.
| av[0] | The nickname of the user that just identified |
EVENT_NICK_LOGOUT
A user has just (been) logged out.
| av[0] | The nickname of the user that has (been) logged out |
EVENT_NICK_REGISTERED
A new user has just registered it's nickname. This event is being emitted when the registration is completed, but the user modes have not yet been set.
| av[0] | The nickname of the newly registered user |
EVENT_NICK_SUSPENDED
A user's nick has just been suspended.
| av[0] | The nickname that has just been suspended |
EVENT_NICK_UNSUSPEND
A user's nick has just been unsuspended.
| av[0] | The nickname that has just been unsuspended |
EVENT_PART_CHANNEL
A user parts a channel.
| av[0] | EVENT_START or EVENT_STOP. EVENT_START when the user is about to be removed from the channel internally, EVENT_STOP when this has been done |
| av[1] | The nickname of the user parting the channel |
| av[2] | The name of the channel the user has parted |
EVENT_RELOAD
This event is emitted after the configuration file has been reloaded.
| av[0] | Always EVENT_START |
EVENT_RESTART
This event is emitted before the services are being restarted.
| av[0] | Always EVENT_START |
EVENT_SERVER_CONNECT
A new server has just connected to the network.
| av[0] | The name of the new server |
EVENT_SERVER_SQUIT
A server has sent an SQUIT and is about to be removed from the network. This event is being sent before the server is actually removed from the network.
| av[0] | The name of the server that is being removed |
EVENT_SHUTDOWN
This event is emitted when Anope is being shut down.
| av[0] | EVENT_START or EVENT_STOP, to indicate where in the process of restarting the core is. With EVENT_START, services are still fully online and operating. With EVENT_STOP, every internal clean up has been done already, and the SQUIT has been sent; the only thing done after emitting the event is closing the socket to the uplink hub |
EVENT_SIGNAL
This event is emitted when Anope is quitting because of a signal it received.
| av[0] | The quit message that will be sent with the SQUIT for this shutdown |
EVENT_TOPIC_UPDATED
A channel topic has been succesfully updated. Note that this event is only emitted if the new topic has been fully accepted and set by the Anope core.
| av[0] | The name of the channel the topic has been set on |
| av[1] | The new topic set on the channel |
EVENT_USER_LOGOFF
A user has left the network. This event is emitted before the internal removal is performed, so the user still exists internally.
| av[0] | The nickname of the user leaving the network |
