serverpackcreator-api/de.griefed.serverpackcreator.api/ApiWrapper

ApiWrapper

class ApiWrapper

API wrapper, allowing you to conveniently initialize, setup and use the different aspects of ServerPackCreator.

Author

Griefed

Parameters

properties

serverpackcreator.properties-file containing settings and configurations to load the API with.

runSetup

Whether to run the file-setup during API inizialization.

Types

Companion

object Companion

Properties

apiPlugins

@get:Synchronized

val apiPlugins: ApiPlugins

This instances plugin manager for ServerPackCreator-plugins, if any are installed. This gives you access to the available extensions, should any be available in your instance of ServerPackCreator.

apiProperties

@get:Synchronized

val apiProperties: ApiProperties

This instances settings used across ServerPackCreator, such as the working-directories, files and other settings.

configurationHandler

@get:Synchronized

val configurationHandler: ConfigurationHandler

This instances ConfigurationHandler for checking a given de.griefed.serverpackcreator.api.config.PackConfig for validity, so a server pack can safely be created from it.

documentBuilderFactory

@get:Synchronized

val documentBuilderFactory: DocumentBuilderFactory

This instances DocumentBuilder for working with XML-data.

fabricScanner

@get:Synchronized

val fabricScanner: FabricScanner

This instances scanner to determine the sideness of Fabric mods.

forgeAnnotationScanner

@get:Synchronized

val forgeAnnotationScanner: ForgeAnnotationScanner

This instances annotation scanner used to determine the sideness of Forge mods for Minecraft 1.12.2 and older.

forgeTomlScanner

val forgeTomlScanner: ForgeTomlScanner

This instances toml scanner to determine the sideness of Forge mods for Minecraft 1.13.x and newer.

jsonUtilities

@get:Synchronized

val jsonUtilities: JsonUtilities

This instances common JSON utilities used across ServerPackCreator.

modScanner

@get:Synchronized

val modScanner: ModScanner

This instances modscanner to determine the sideness of a given Forge, Fabric, LegacyFabric or Quilt mod.

neoForgeTomlScanner

@get:Synchronized

val neoForgeTomlScanner: NeoForgeTomlScanner

This instances toml scanner to determine the sideness of NeoForge mods for Minecraft 1.20.5 and newer.

objectMapper

@get:Synchronized

val objectMapper: ObjectMapper

This instances JSON-ObjectMapper used across ServerPackCreator with which this instance was initialized. By default, the ObjectMapper used across ServerPackCreator has the following features set:

properties

val properties: File

quiltScanner

@get:Synchronized

val quiltScanner: QuiltScanner

This instances scanner to determine the sideness of Quilt mods.

serverPackHandler

@get:Synchronized

val serverPackHandler: ServerPackHandler

This instances ServerPackHandler used to turn a de.griefed.serverpackcreator.api.config.PackConfig into a server pack.

setupWasRun

var setupWasRun: Boolean

tomlParser

@get:Synchronized

val tomlParser: TomlParser

This instances toml parser to read and parse various .toml-files during mod-scanning, plugin- and extension config loading and provisioning, serverpackcreator.conf reading and more.

utilities

@get:Synchronized

val utilities: Utilities

This instances collection of common utilities used across ServerPackCreator.

versionMeta

@get:Synchronized

val versionMeta: VersionMeta

This instances version meta used for checking version-correctness of Minecraft and supported modloaders, as well as gathering information about Minecraft servers and modloader installers.

versionsRegex

val versionsRegex: Regex

webUtilities

@get:Synchronized

val webUtilities: WebUtilities

This instances common web utilities used across ServerPackCreator.

xmlJsonRegex

val xmlJsonRegex: Regex

xmlUtilities

@get:Synchronized

val xmlUtilities: XmlUtilities

This instances common XML utilities used across ServerPackCreator.