Package de.griefed.serverpackcreator.api.plugins.configurationhandler

Interface ConfigCheckExtension

  • All Implemented Interfaces:
    de.griefed.serverpackcreator.api.plugins.BaseInformation , de.griefed.serverpackcreator.api.plugins.ExtensionInformation , org.pf4j.ExtensionPoint 
    
public interface ConfigCheckExtension
 implements ExtensionInformation

    Extension point for configuration checks, so you can run your own checks on a given PackConfig should you so desire.

    Author:

    Griefed

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Boolean runCheck(VersionMeta versionMeta, ApiProperties apiProperties, Utilities utilities, PackConfig packConfig, ConfigCheck configCheck, Optional<CommentedConfig> pluginConfig, ArrayList<CommentedConfig> packSpecificConfigs)

      • Methods inherited from class de.griefed.serverpackcreator.api.plugins.ExtensionInformation

        getExtensionId

      • Methods inherited from class de.griefed.serverpackcreator.api.plugins.BaseInformation

        getAuthor, getDescription, getName, getVersion

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • runCheck

         abstract Boolean runCheck(VersionMeta versionMeta, ApiProperties apiProperties, Utilities utilities, PackConfig packConfig, ConfigCheck configCheck, Optional<CommentedConfig> pluginConfig, ArrayList<CommentedConfig> packSpecificConfigs)
        Parameters:
        versionMeta - Instance of VersionMeta so you can work with available Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.
        apiProperties - Instance of ApiProperties 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.
        packConfig - The configuration to check.
        configCheck - Contains all encountered errors during the check of the passed configuration.
        pluginConfig - Configuration for this plugin, conveniently provided by ServerPackCreator.
        packSpecificConfigs - Modpack and server pack specific configurations for this plugin, conveniently provided by ServerPackCreator.
        Returns:

        true if an error was encountered. false if the checks were successful.