ff14bot.Interfaces.IBotPlugin Interface Reference

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

Inheritance diagram for ff14bot.Interfaces.IBotPlugin:

Public Member Functions
void	OnButtonPress ()
	Called when the user presses the settings button.
void	OnPulse ()
	Executes the pulse action. This is called every "tick" of the bot.
void	OnInitialize ()
	Executes the initialize action. This is called at initial bot startup. (When the bot itself is started, not when Start() is called)
void	OnShutdown ()
	Executes the shutdown action. This is called when the bot is shutting down and when plugins are being reloaded.
void	OnEnabled ()
	Executes the enabled action. This is called when the user has enabled this specific plugin via the GUI.
void	OnDisabled ()
	Executes the disabled action. This is called whent he user has disabled this specific plugin via the GUI.

Properties
string	Author [get]
	Name of the user who created the plugin.
Version	Version [get]
	Version of the plugin.
string	Name [get]
	Name of the plugin.
string	Description [get]
	Short description about the plugin.
bool	WantButton [get]
	Should the plugin settings button be enabled.
string	ButtonText [get]
	Text of the plugins button.

Detailed Description

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

Member Function Documentation

OnButtonPress()

void ff14bot.Interfaces.IBotPlugin.OnButtonPress

(

)

Called when the user presses the settings button.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

OnDisabled()

void ff14bot.Interfaces.IBotPlugin.OnDisabled

(

)

Executes the disabled action. This is called whent he user has disabled this specific plugin via the GUI.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

OnEnabled()

void ff14bot.Interfaces.IBotPlugin.OnEnabled

(

)

Executes the enabled action. This is called when the user has enabled this specific plugin via the GUI.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

OnInitialize()

void ff14bot.Interfaces.IBotPlugin.OnInitialize

(

)

Executes the initialize action. This is called at initial bot startup. (When the bot itself is started, not when Start() is called)

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

OnPulse()

void ff14bot.Interfaces.IBotPlugin.OnPulse

(

)

Executes the pulse action. This is called every "tick" of the bot.

Implemented in ff14bot.AClasses.BotPlugin.

OnShutdown()

void ff14bot.Interfaces.IBotPlugin.OnShutdown

(

)

Executes the shutdown action. This is called when the bot is shutting down and when plugins are being reloaded.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

Property Documentation

Author

string ff14bot.Interfaces.IBotPlugin.Author

get

Name of the user who created the plugin.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

ButtonText

string ff14bot.Interfaces.IBotPlugin.ButtonText

get

Text of the plugins button.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

Description

string ff14bot.Interfaces.IBotPlugin.Description

get

Short description about the plugin.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

Name

string ff14bot.Interfaces.IBotPlugin.Name

get

Name of the plugin.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

Version

Version ff14bot.Interfaces.IBotPlugin.Version

get

Version of the plugin.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.

WantButton

bool ff14bot.Interfaces.IBotPlugin.WantButton

get

Should the plugin settings button be enabled.

Implemented in ff14bot.AClasses.BotPlugin, and UpdateBuddy.UpdateBuddyPlugin.