serverpackcreator-api/de.griefed.serverpackcreator.api.plugins.swinggui/ConfigPanelExtension

ConfigPanelExtension

interface ConfigPanelExtension : ExtensionInformation

Extension point for plugins which add additional javax.swing.JPanels in a given server pack tab, allowing users to customize server pack specific configurations of a plugin.

Author

Griefed

Properties

Link copied to clipboard
abstract val author: String

Get the author of this plugin.

Link copied to clipboard
abstract val description: String

Get the description of this plugin.

Link copied to clipboard
abstract val extensionId: String

The ID of this extension. Used by ServerPackCreator to determine which configuration, if any, to provide to any given extension being run.

Link copied to clipboard
abstract val name: String

Get the name of this plugin.

Link copied to clipboard
abstract val version: String

Get the version of this plugin.

Functions

Link copied to clipboard
abstract fun getPanel(versionMeta: VersionMeta, apiProperties: ApiProperties, utilities: Utilities, serverPackConfigTab: ServerPackConfigTab, pluginConfig: Optional<CommentedConfig>, extensionName: String, pluginID: String): ExtensionConfigPanel

This method gets called when an extension of this type is run. All parameters are provided by ServerPackCreator, so you do not have to take care of them. A ConfigPanel is intended to be used to change server pack-specific configurations which can then be used by other extensions in your plugin. A simple example would be downloading a specific version of some mod. You could add a panel which lets the user configure the version of the mod to use. When the user then runs the server pack generation, your setting will be stored in the subsequently generated serverpackcreator.conf, and could be used in any of the de.griefed.serverpackcreator.api.serverpack.ServerPackHandler extension-points, which would then download the version you specified via this here panel.