IRCEventHandler

Aggregate to annotate event handler functions with, to control what they do and how they work.

Members

Aliases

_addCommand
alias _addCommand = commands

Alias to make kameloso.traits.UnderscoreOpDispatcher redirect calls to commands but by the name addCommand.

_addRegex
alias _addRegex = regexes

Alias to make kameloso.traits.UnderscoreOpDispatcher redirect calls to regexes but by the name addRegex.

_onEvent
alias _onEvent = acceptedEventTypes

Alias to make kameloso.traits.UnderscoreOpDispatcher redirect calls to acceptedEventTypes but by the name onEvent.

Functions

generateTypemap
void generateTypemap()

Generates acceptedEventTypeMap from acceptedEventTypes.

Mixins

__anonymous
mixin UnderscoreOpDispatcher
Undocumented in source.

Structs

Command
struct Command

Embodies the notion of a chat command, e.g. !hello.

Regex
struct Regex

Embodies the notion of a chat command regular expression, e.g. ![Hh]ello+.

Variables

_chainable
bool _chainable;

Whether or not the annotated event handler function should allow other functions to fire after it. If not set (default false), it will terminate and move on to the next plugin after the function returns.

_channelPolicy
ChannelPolicy _channelPolicy;

What kind of channel the annotated event handler function may be triggered in; homes or mere guest channels.

_fiber
bool _fiber;

Whether or not the annotated event handler should be run from within a Fiber.

_permissionsRequired
Permissions _permissionsRequired;

Permissions required of instigating user, below which the annotated event handler function should not be triggered.

_verbose
bool _verbose;

Whether or not additional information should be output to the local terminal as the function is (or is not) triggered.

_when
Timing _when;

Special instruction related to the order of which event handler functions within a plugin module are triggered.

acceptedEventTypeMap
bool[] acceptedEventTypeMap;

Array of accepted IRCEvent.Types.

acceptedEventTypes
IRCEvent.Type[] acceptedEventTypes;

Array of types of dialect.defs.IRCEvent that the annotated event handler function should accept.

commands
Command[] commands;

Array of IRCEventHandler.Commands the bot should pick up and listen for.

fqn
string fqn;

Fully qualified name of the function the annotated IRCEventHandler is attached to.

regexes
Regex[] regexes;

Array of IRCEventHandler.Regexes the bot should pick up and listen for.

Mixed In Members

From mixin UnderscoreOpDispatcher

opDispatch
auto ref opDispatch(T value)
Undocumented in source. Be warned that the author may not have intended to support it.
opDispatch
auto opDispatch()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta