BotPlugin Class |
Base plugin class that all plugins should inherit from
Inheritance HierarchyNamespace: ff14bot.AClasses
Assembly: RebornBuddy (in RebornBuddy.exe) Version: 3.3.1; net-4.5.win32; release
SyntaxC#
public abstract class BotPlugin : IDisposable, IEquatable<IBotPlugin>, IEquatable<BotPlugin>, IBotPlugin
The BotPlugin type exposes the following members.
ConstructorsProperties| 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 | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| DoInitialize |
Executes Initialize if it hasn't been run already
|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).) |
| Equals(BotPlugin) | Indicates whether the current object is equal to another object of the same type. |
| Equals(IBotPlugin) | Indicates whether the current object is equal to another object of the same type. |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnButtonPress | Called when the user presses the settings button |
| OnDisabled | Executes the disabled action. This is called when the 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. |
| 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. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Operators| Name | Description | |
|---|---|---|
  | Equality | |
| Inequality |
See Also