Package tech.anonymoushacker1729.cobaltconfig.config

Class ConfigManager.ConfigBuilder

java.lang.Object

tech.anonymoushacker1729.cobaltconfig.config.ConfigManager.ConfigBuilder

Enclosing class:

ConfigManager

public static class ConfigManager.ConfigBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
ConfigBuilder(String modId, @Nullable String suffix, Class<?> configClass)	Creates a new ConfigBuilder instance with a suffix.
ConfigBuilder(String modId, Class<?> configClass)	Creates a new ConfigBuilder instance with no suffix.

Method Summary

Modifier and Type	Method	Description
void	build()	Build a new ConfigManager instance.
ConfigManager.ConfigBuilder	setClientOnly(boolean clientOnly)	Mark a config as client-only.
ConfigManager.ConfigBuilder	setConfigName(String configName)	Set the config name.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigBuilder

@AvailableSince("1.0.0")
public ConfigBuilder(String modId,
 Class<?> configClass)

Creates a new ConfigBuilder instance with no suffix.

Parameters:

modId - the mod ID

configClass - the config class

ConfigBuilder

@AvailableSince("1.0.0")
public ConfigBuilder(String modId,
 @Nullable
 @Nullable String suffix,
 Class<?> configClass)

Creates a new ConfigBuilder instance with a suffix.

Parameters:

modId - the mod ID

suffix - the suffix

configClass - the config class

Method Details

setClientOnly

@AvailableSince("1.0.0")
public ConfigManager.ConfigBuilder setClientOnly(boolean clientOnly)

Mark a config as client-only. These will not be generated in dedicated server environments and therefore are not synced to clients.

Defaults to false.

Parameters:

clientOnly - whether the config is client-only

Returns:

ConfigBuilder

setConfigName

@AvailableSince("1.0.0")
public ConfigManager.ConfigBuilder setConfigName(String configName)

Set the config name. If not provided, the config class name will be used.

This is used for listing available config buttons in the config screen, if one is registered.

Parameters:

configName - the config name

Returns:

ConfigBuilder

build

@AvailableSince("1.0.0")
public void build()

Build a new ConfigManager instance.