ff14bot.AClasses.BotPlugin Class Reference

Base plugin class that all plugins should inherit from. More...

Inheritance diagram for ff14bot.AClasses.BotPlugin:

Public Member Functions
virtual void	Dispose ()
bool	Equals (BotPlugin other)
bool	Equals (IBotPlugin other)
override bool	Equals (object obj)
override int	GetHashCode ()
void	DoInitialize ()
	Executes Initialize if it hasn't been run already.
virtual void	OnButtonPress ()
	Called when the user presses the settings button.
virtual void	OnPulse ()
	Executes the pulse action. This is called every "tick" of the bot.
virtual void	OnInitialize ()
	Executes the initialize action.
virtual void	OnShutdown ()
	Executes the shutdown action. This is called when the bot is shutting down and when plugins are being reloaded.
virtual void	OnEnabled ()
	Executes the enabled action. This is called when the user has enabled this specific plugin via the GUI.
virtual void	OnDisabled ()
	Executes the disabled action. This is called when the user has disabled this specific plugin via the GUI.

Static Public Member Functions
static bool	operator== (BotPlugin left, BotPlugin right)
static bool	operator!= (BotPlugin left, BotPlugin right)

Protected Member Functions
	BotPlugin ()
	Constructor for plugins.

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

Detailed Description

Base plugin class that all plugins should inherit from.

Constructor & Destructor Documentation

BotPlugin()

ff14bot.AClasses.BotPlugin.BotPlugin ( )

protected

Constructor for plugins.

Member Function Documentation

Dispose()

virtual void ff14bot.AClasses.BotPlugin.Dispose ( )

virtual

DoInitialize()

void ff14bot.AClasses.BotPlugin.DoInitialize

(

)

Executes Initialize if it hasn't been run already.

Equals() [1/3]

bool ff14bot.AClasses.BotPlugin.Equals

(

BotPlugin

other

)

Equals() [2/3]

bool ff14bot.AClasses.BotPlugin.Equals

(

IBotPlugin

other

)

Equals() [3/3]

override bool ff14bot.AClasses.BotPlugin.Equals

(

object

obj

)

GetHashCode()

override int ff14bot.AClasses.BotPlugin.GetHashCode

(

)

OnButtonPress()

virtual void ff14bot.AClasses.BotPlugin.OnButtonPress ( )

virtual

Called when the user presses the settings button.

Implements ff14bot.Interfaces.IBotPlugin.

Reimplemented in UpdateBuddy.UpdateBuddyPlugin.

OnDisabled()

virtual void ff14bot.AClasses.BotPlugin.OnDisabled ( )

virtual

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

Implements ff14bot.Interfaces.IBotPlugin.

Reimplemented in UpdateBuddy.UpdateBuddyPlugin.

OnEnabled()

virtual void ff14bot.AClasses.BotPlugin.OnEnabled ( )

virtual

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

Implements ff14bot.Interfaces.IBotPlugin.

Reimplemented in UpdateBuddy.UpdateBuddyPlugin.

OnInitialize()

virtual void ff14bot.AClasses.BotPlugin.OnInitialize ( )

virtual

Executes the initialize action.

Implements ff14bot.Interfaces.IBotPlugin.

Reimplemented in UpdateBuddy.UpdateBuddyPlugin.

OnPulse()

virtual void ff14bot.AClasses.BotPlugin.OnPulse ( )

virtual

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

Implements ff14bot.Interfaces.IBotPlugin.

OnShutdown()

virtual void ff14bot.AClasses.BotPlugin.OnShutdown ( )

virtual

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

Implements ff14bot.Interfaces.IBotPlugin.

Reimplemented in UpdateBuddy.UpdateBuddyPlugin.

operator!=()

bool ff14bot.AClasses.BotPlugin.operator!= ( BotPlugin left, BotPlugin right )

static

Parameters

left
right

Returns

operator==()

bool ff14bot.AClasses.BotPlugin.operator== ( BotPlugin left, BotPlugin right )

static

Parameters

left
right

Returns

Property Documentation

Author

string ff14bot.AClasses.BotPlugin.Author

getabstract

Name of the user who created the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

ButtonText

virtual string ff14bot.AClasses.BotPlugin.ButtonText

get

Text of the plugins button.

Implements ff14bot.Interfaces.IBotPlugin.

Description

virtual string ff14bot.AClasses.BotPlugin.Description

get

Short description about the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

Name

string ff14bot.AClasses.BotPlugin.Name

getabstract

Name of the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

Version

Version ff14bot.AClasses.BotPlugin.Version

getabstract

Version of the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

WantButton

virtual bool ff14bot.AClasses.BotPlugin.WantButton

get

Should the plugin settings button be enabled.

Implements ff14bot.Interfaces.IBotPlugin.