de.griefed.serverpackcreator.addons.swinggui

Interface ConfigPanelExtension

All Superinterfaces:

BaseInformation, ExtensionInformation, org.pf4j.ExtensionPoint

public interface ConfigPanelExtension
extends ExtensionInformation

Extension point for addons which add additional JPanels in a given server pack tab, allowing users to customize server pack specific configurations of an addon.

Method Summary

Modifier and Type

Method and Description

@NotNull ExtensionConfigPanel

getPanel(@NotNull VersionMeta versionMeta, @NotNull ApplicationProperties applicationProperties, @NotNull Utilities utilities, @NotNull TabCreateServerPack tabCreateServerPack, @NotNull java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig> addonConfig, @NotNull java.lang.String extensionName, @NotNull java.lang.String pluginID) This method gets called when an extension of this type is run.

Methods inherited from interface de.griefed.serverpackcreator.addons.ExtensionInformation

getExtensionId

Methods inherited from interface de.griefed.serverpackcreator.addons.BaseInformation

getAuthor, getDescription, getName, getVersion

Method Detail

getPanel

@NotNull
@NotNull ExtensionConfigPanel getPanel(@NotNull
                                                @NotNull VersionMeta versionMeta,
                                                @NotNull
                                                @NotNull ApplicationProperties applicationProperties,
                                                @NotNull
                                                @NotNull Utilities utilities,
                                                @NotNull
                                                @NotNull TabCreateServerPack tabCreateServerPack,
                                                @NotNull
                                                @NotNull java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig> addonConfig,
                                                @NotNull
                                                @NotNull java.lang.String extensionName,
                                                @NotNull
                                                @NotNull java.lang.String pluginID)

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 ServerPackHandler extension-points, which would then download the version you specified via this here panel.

Parameters:

versionMeta - Instance of VersionMeta so you can work with available Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.

applicationProperties - Instance of ApplicationProperties The current configuration of ServerPackCreator, like the default list of clientside-only mods, the server pack directory etc.

utilities - Instance of Utilities commonly used across ServerPackCreator.

tabCreateServerPack - Instance of TabCreateServerPack to give you access to the various fields inside it, like the modpack directory, selected Minecraft, modloader and modloader versions, etc.

addonConfig - Addon specific configuration conveniently provided by ServerPackCreator. This is the global configuration of the addon which provides the ConfigPanelExtension to ServerPackCreator.

extensionName - The name the titled border of this ConfigPanel will get.

pluginID - The same as the PluginId.

Returns:

A ConfigPanel allowing users to further customize their ServerPackCreator experience when using an addon.