Package com.soulfiremc.server.settings.lib

Class ServerSettingsRegistry

java.lang.Object

com.soulfiremc.server.settings.lib.ServerSettingsRegistry

public final class ServerSettingsRegistry
extends Object

Constructor Summary

Constructors

Constructor	Description
ServerSettingsRegistry()

Method Summary

Modifier and Type	Method	Description
ServerSettingsRegistry	addInternalPage(Class<? extends SettingsObject> clazz, String pageName)	Registers an internal class with the settings registry.
ServerSettingsRegistry	addPluginPage(Class<? extends SettingsObject> clazz, String pageName, Plugin owningPlugin, String iconId, BooleanProperty enabledProperty)	Registers an internal class with the settings registry.
List<SettingsPage>	exportSettingsMeta()

Methods inherited from class java.lang.Object

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

Constructor Details

ServerSettingsRegistry

public ServerSettingsRegistry()

Method Details

addInternalPage

@Internal
public ServerSettingsRegistry addInternalPage(Class<? extends SettingsObject> clazz,
 String pageName)

Registers an internal class with the settings registry. This is for classes associated to internal settings. They need to be handled explicitly by the client.

Parameters:

clazz - The class to register

Returns:

The registry

addPluginPage

public ServerSettingsRegistry addPluginPage(Class<? extends SettingsObject> clazz,
 String pageName,
 Plugin owningPlugin,
 String iconId,
 BooleanProperty enabledProperty)

Registers an internal class with the settings registry. This is normally used for plugins, provide your plugin info to register the settings to your plugin.

Parameters:

clazz - The class to register

pageName - The name of the page

owningPlugin - The owning plugin

iconId - The icon id Icons ids are from lucide.dev

Returns:

The registry

exportSettingsMeta

public List<SettingsPage> exportSettingsMeta()