UpdateBuddy.UpdateBuddyPlugin Class Reference

Inheritance diagram for UpdateBuddy.UpdateBuddyPlugin:

Public Member Functions
override void	OnInitialize ()
	Executes the initialize action.
override void	OnEnabled ()
	Executes the enabled action. This is called when the user has enabled this specific plugin via the GUI.
override void	OnDisabled ()
	Executes the disabled action. This is called when the user has disabled this specific plugin via the GUI.
void	StartUpdate ()
override void	OnButtonPress ()
	Called when the user presses the settings button.
override void	OnShutdown ()
	Executes the shutdown action. This is called when the bot is shutting down and when plugins are being reloaded.
Public Member Functions inherited from ff14bot.AClasses.BotPlugin
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	OnPulse ()
	Executes the pulse action. This is called every "tick" of the bot.

Static Public Member Functions
static void	SetRequiresRestart (bool value)
static void	Restart ()
Static Public Member Functions inherited from ff14bot.AClasses.BotPlugin
static bool	operator== (BotPlugin left, BotPlugin right)
static bool	operator!= (BotPlugin left, BotPlugin right)

Static Public Attributes
static UpdateBuddyPlugin	Instance = new UpdateBuddyPlugin()

Properties
override string	Name [get]
	Name of the plugin.
override string	Author [get]
	Name of the user who created the plugin.
override Version	Version [get]
	Version of the plugin.
override string	Description [get]
	Short description about the plugin.
override bool	WantButton [get]
	Should the plugin settings button be enabled.
override string	ButtonText [get]
	Text of the plugins button.
static bool	RequiresRestart [get]
static bool	IsFullyLoaded [get]
static bool	IsRunningTask [get, set]
Task	UpdateTask = Task.CompletedTask [get]
Properties inherited from ff14bot.AClasses.BotPlugin
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.

Events
static ? Action	TaskRunningFinished

Additional Inherited Members
Protected Member Functions inherited from ff14bot.AClasses.BotPlugin
	BotPlugin ()
	Constructor for plugins.

Member Function Documentation

OnButtonPress()

override void UpdateBuddy.UpdateBuddyPlugin.OnButtonPress ( )

virtual

Called when the user presses the settings button.

Reimplemented from ff14bot.AClasses.BotPlugin.

OnDisabled()

override void UpdateBuddy.UpdateBuddyPlugin.OnDisabled ( )

virtual

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

Reimplemented from ff14bot.AClasses.BotPlugin.

OnEnabled()

override void UpdateBuddy.UpdateBuddyPlugin.OnEnabled ( )

virtual

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

Reimplemented from ff14bot.AClasses.BotPlugin.

OnInitialize()

override void UpdateBuddy.UpdateBuddyPlugin.OnInitialize ( )

virtual

Executes the initialize action.

Reimplemented from ff14bot.AClasses.BotPlugin.

OnShutdown()

override void UpdateBuddy.UpdateBuddyPlugin.OnShutdown ( )

virtual

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

Reimplemented from ff14bot.AClasses.BotPlugin.

Restart()

void UpdateBuddy.UpdateBuddyPlugin.Restart ( )

static

SetRequiresRestart()

void UpdateBuddy.UpdateBuddyPlugin.SetRequiresRestart ( bool value )

static

StartUpdate()

void UpdateBuddy.UpdateBuddyPlugin.StartUpdate

(

)

Member Data Documentation

Instance

UpdateBuddyPlugin UpdateBuddy.UpdateBuddyPlugin.Instance = new UpdateBuddyPlugin()

static

Property Documentation

Author

override string UpdateBuddy.UpdateBuddyPlugin.Author

get

Name of the user who created the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

ButtonText

override string UpdateBuddy.UpdateBuddyPlugin.ButtonText

get

Text of the plugins button.

Implements ff14bot.Interfaces.IBotPlugin.

Description

override string UpdateBuddy.UpdateBuddyPlugin.Description

get

Short description about the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

IsFullyLoaded

bool UpdateBuddy.UpdateBuddyPlugin.IsFullyLoaded

staticget

IsRunningTask

bool UpdateBuddy.UpdateBuddyPlugin.IsRunningTask

staticgetset

Name

override string UpdateBuddy.UpdateBuddyPlugin.Name

get

Name of the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

RequiresRestart

bool UpdateBuddy.UpdateBuddyPlugin.RequiresRestart

staticget

UpdateTask

Task UpdateBuddy.UpdateBuddyPlugin.UpdateTask = Task.CompletedTask

get

Version

override Version UpdateBuddy.UpdateBuddyPlugin.Version

get

Version of the plugin.

Implements ff14bot.Interfaces.IBotPlugin.

WantButton

override bool UpdateBuddy.UpdateBuddyPlugin.WantButton

get

Should the plugin settings button be enabled.

Implements ff14bot.Interfaces.IBotPlugin.

Event Documentation

TaskRunningFinished

? Action UpdateBuddy.UpdateBuddyPlugin.TaskRunningFinished

static