Jon Portnoy > Bot-Cobalt-0.016002 > Bot::Cobalt::Conf::File::PerPlugin

Download:
Bot-Cobalt-0.016002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.016002   Source  

NAME ^

Bot::Cobalt::Conf::File::PerPlugin - Bot::Cobalt plugin configs

SYNOPSIS ^

  my $this_plugin_cf = Bot::Cobalt::Conf::File::PerPlugin->new(
    module => 'Plugin::Module',
        
    ## Optional; loads to ->opts attrib:
    config_file => $path_to_cf_file,
    
    ## Optional; overrides config_file settings in ->opts:
    extra_opts => {
      LevelRequired => 1,
    },

    ## Optional; used by Bot::Cobalt::Core    
    autoload => 1,    
    priority => 1,
  );

  my $priority = $this_plugin_cf->priority;
  
  my $autoload = $this_plugin_cf->autoload;
  
  my $plugin_opts = $this_plugin_cf->opts;

  ## Force a reload:
  $this_plugin_cf->reload_conf;

DESCRIPTION ^

A plugin-specific configuration.

These objects are usually managed by a Bot::Cobalt::Conf::File::Plugins instance.

This class consumes Bot::Cobalt::Conf::Role::Reader.

(This is a core configuration class; Plugin authors should 'use Bot::Cobalt;' and retrieve the opts attribute via plugin_cfg instead.)

AUTHOR ^

Jon Portnoy <avenj@cobaltirc.org>

syntax highlighting: