cPlugin describes a Lua plugin. This page is dedicated to new-style plugins and contain their functions. Each plugin has its own cPlugin object.
| Name | Parameters | Return value | Notes |
|---|
| GetDirectory |
|
string |
OBSOLETE, use GetFolderName() instead! |
| GetFolderName |
|
string |
Returns the name of the folder where the plugin's files are. (APIDump) |
| GetLoadError |
|
string |
If the plugin failed to load, returns the error message for the failure. |
| GetLocalDirectory |
|
|
OBSOLETE, use GetLocalFolder instead. |
| GetLocalFolder |
|
string |
Returns the path where the plugin's files are. (Plugins/APIDump) |
| GetName |
|
string |
Returns the name of the plugin. |
| GetStatus |
|
PluginStatus |
Returns the status of the plugin (loaded, disabled, unloaded, error, not found) |
| GetVersion |
|
number |
Returns the version of the plugin. |
| IsLoaded |
|
|
|
| SetName |
string |
|
Sets the name of the Plugin. |
| SetVersion |
number |
|
Sets the version of the plugin. |