IBotPlugin Interface

Base interface for plugins, should have not been exposed but too late for that as some plugins inherited it.

Namespace: ff14bot.Interfaces
Assembly: RebornBuddy (in RebornBuddy.exe) Version: 3.3.1; net-4.5.win32; release

Syntax

public interface IBotPlugin : IEquatable<IBotPlugin>

The IBotPlugin type exposes the following members.

Properties

	Name	Description
	Author	Name of the user who created the plugin
	ButtonText	Text of the plugins button
	Description	Short description about the plugin
	Name	Name of the plugin
	Version	Version of the plugin
	WantButton	Should the plugin settings button be enabled

Methods

	Name	Description
	Equals	Indicates whether the current object is equal to another object of the same type. (Inherited from IEquatableIBotPlugin.)
	OnButtonPress	Called when the user presses the settings button
	OnDisabled	Executes the disabled action. This is called whent he user has disabled this specific plugin via the GUI.
	OnEnabled	Executes the enabled action. This is called when the user has enabled this specific plugin via the GUI.
	OnInitialize	Executes the initialize action. This is called at initial bot startup. (When the bot itself is started, not when Start() is called)
	OnPulse	Executes the pulse action. This is called every "tick" of the bot.
	OnShutdown	Executes the shutdown action. This is called when the bot is shutting down and when plugins are being reloaded.