ServerPackCreatorPlugin 9.3.0 API

All Implemented Interfaces:

de.griefed.serverpackcreator.api.plugins.BaseInformation
```
public abstract class ServerPackCreatorPlugin
extends Plugin implements BaseInformation
                    
```
A ServerPackCreator plugin provides additional functionality to ServerPackCreator via any of
and
- de.griefed.serverpackcreator.api.plugins.swinggui.ExtensionConfigPanel
- de.griefed.serverpackcreator.api.plugins.swinggui.ExtensionTab
For details on pf4j, the library used to realize the plugin-functionality in ServerPackCreator, visit pf4j.org
Author:

Griefed

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final PluginContext`	`context`
`private final String`	`name`
`private final String`	`description`
`private final String`	`author`
`private final String`	`version`
`private final String`	`id`
`private final KotlinLogger`	`pluginsLog`
`private final PluginWrapper`	`wrapper`
`protected final Logger`	`log`

Constructor Summary

Constructors
Constructor	Description
`ServerPackCreatorPlugin(PluginContext context)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final PluginContext`	`getContext()`
`final String`	`getName()`	Shown in the GUI's plugin list and named in `plugins.log` whenever this extension misbehaves.
`final String`	`getDescription()`	One line telling a user what this does, shown beside name.
`final String`	`getAuthor()`	Credited in the GUI; free-form, and never used to identify anything.
`final String`	`getVersion()`	Displayed as-is.
`final String`	`getId()`	The plugin's id.
`final KotlinLogger`	`getPluginsLog()`
`Unit`	`start()`	This method is called by the application when the plugin is started.
`Unit`	`stop()`	This method is called by the application when the plugin is stopped.

Methods inherited from class org.pf4j.Plugin
delete, getWrapper
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServerPackCreatorPlugin
```
ServerPackCreatorPlugin(PluginContext context)
```
    Parameters:
    
    context - PluginWrapper provided by ServerPackCreator.
- Method Detail
  - getContext
```
 final PluginContext getContext()
```
  - getName
```
 final String getName()
```
    Shown in the GUI's plugin list and named in plugins.log whenever this extension misbehaves.
  - getDescription
```
 final String getDescription()
```
    One line telling a user what this does, shown beside name.
  - getAuthor
```
 final String getAuthor()
```
    Credited in the GUI; free-form, and never used to identify anything.
  - getVersion
```
 final String getVersion()
```
    Displayed as-is. SPC compares nothing against it, so any scheme works.
  - getId
```
 final String getId()
```
    The plugin's id. Used as the key its configuration is stored under, so it must be stable across releases.
  - getPluginsLog
```
 final KotlinLogger getPluginsLog()
```
  - start
```
 Unit start()
```
    This method is called by the application when the plugin is started. See PluginManager.startPlugin.
    If you intend on overwriting this method, make sure to call super.start() first.
  - stop
```
 Unit stop()
```
    This method is called by the application when the plugin is stopped. See PluginManager.stopPlugin.
    If you intend on overwriting this method, make sure to call super.start() first.