Gary Warman > POE-Component-IRC-Plugin-WubWubWub-0.1 > POE::Component::IRC::Plugin::WubWubWub

Download:
POE-Component-IRC-Plugin-WubWubWub-0.1.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.1   Source  

NAME ^

POE::Component::IRC::Plugin::WubWubWub - Wubbalize your IRC bots!

VERSION ^

Version 0.1

SYNOPSIS ^

This plugin was designed to make your IRC bots 1000x cooler by integrating this strange phenomenon referred to as dubstep into them. The manner in which it achieves this, is of course, by randomly WUBBING into your chat rooms!

    use POE::Component::IRC;
    use POE::Component::IRC::Plugin::WubWubWub;

    my $WubWubWub = POE::Component::IRC::Plugin::WubWubWub->new({ 
                        #options, documented below
    });
    $irc->plugin_add( 'WubWubWub', $WubWubWUb );
    ...

METHODS ^

new

Creates a new WubWubWub object. View the arguments below to grok everything you could ever need to know. Calling syntax expects a hashref of arguments.

ARGUMENTS ^

threshold

A threshold at which, when exceeded, will tell your bot it's okay to wub. Defaults to 0.5; should be 0 < threshold < 1.

period

A rate limiting mechanism in seconds; if the bot detects that it's been less than the amount of seconds you specify, it'll stay quiet, Defaults to 30 seconds.

min_wubs

The minimum amount of wubs to send at any given moment when wubs are to be sent! Defaults to be 5. Should be 0 < min_wubs < max_wubs

max_wubs

The maximum amount of wubs to send at any given moment when wubs are to be sent! Defaults to be 20. Should be max_wubs > min_wubs > 0.

wub_str

The string to emit to the channel. Defaults to WUB.

AUTHOR ^

Gary Warman, <sirmxe at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-poe-component-irc-plugin-wubwubwub at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-IRC-Plugin-WubWubWub. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc POE::Component::IRC::Plugin::WubWubWub

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2012 Gary Warman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: