User:AnomieBOT/source/d/Trial.pm/doc

NAME
d::Trial - AnomieBOT trial utility decorator

SYNOPSIS
use AnomieBOT::API; $api = new AnomieBOT::API('conf.ini', 1); $api->decorators(qw/d::Trial/);

DESCRIPTION
contains utility functions for use by an AnomieBOT task in trial. When "d::Trial" is used as a decorator on the API object, the following methods are available.

In addition, all d::Talk methods are also available, as this decorator uses them internally.

METHODS PROVIDED

 * $api->check_trial( $until, $brfa )
 * Checks if the current timestamp is past the  timestamp. If not, returns false; if so, whines to the bot talk page and returns a scalar ref that should be dereferenced and returned.


 * $api->trial_complete( $brfa )
 * Whines to the bot talk page and returns a value that should be returned.

COPYRIGHT
Copyright 2008–2013 Anomie

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.