Skip to content

sd_utils.plugins.plugin_base

pencil-pusher edited this page Apr 19, 2021 · 2 revisions

Table of Contents

sd_utils.plugins.plugin_base

PluginBase

class PluginBase()

on_register

 | on_register(data: Any = None)

runs when this plugin is registered with the plugin manager

Arguments:

  • data Any - any parameters passed to this plugin from the plugin manager

on_search

 | on_search(data: Any = None)

runs when the manager begins a query for any plugin.

Arguments:

  • data Any - any parameters passed to this plugin from the plugin manager

on_find

 | on_find(data: Any = None) -> Any

runs when the manager specifically queries this plugin

Arguments:

  • data Any - any parameters passed to this plugin from the plugin manager

on_iterate

 | on_iterate(data: Any = None)

runs when the manager specifically calls iterate_all

Arguments:

  • data Any - any parameters passed to this plugin from the plugin manager
Clone this wiki locally