Package org.polyfrost.oneconfig.api.config.v1

Class CompatSnapshots

java.lang.Object

org.polyfrost.oneconfig.api.config.v1.CompatSnapshots

All Implemented Interfaces:

ConfigManager.ProfileChangeListener

@Internal
public final class CompatSnapshots
extends Object
implements ConfigManager.ProfileChangeListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM_RESET_METADATA
static final String	GATE_METADATA
static final CompatSnapshots	INSTANCE
static final String	KEY_METADATA
static final String	NO_SNAPSHOT_META
static final String	SNAPSHOT_METADATA

Method Summary

Modifier and Type	Method	Description
static void	capture(org.polyfrost.oneconfig.api.config.v1.Tree tree)
static boolean	isApplying()
void	onProfileChanged(String newProfile)
void	onProfileCreated(String profile)
void	onProfileDeleted(String profile)
void	onProfileRenamed(String oldProfile, String newProfile)
void	onProfileSaving(String profile)
static org.polyfrost.oneconfig.api.config.v1.Tree	register(org.polyfrost.oneconfig.api.config.v1.Tree tree)
static void	setDispatcher(Consumer<Runnable> dispatcher)
static void	setLiveValueScope(BiConsumer<String,Runnable> scope)	Sets what every read of the live option values runs inside Lets whoever temporarily overwrites a mod's options put the user's own values back for the duration, so the substitutes are never mistaken for them
static org.polyfrost.oneconfig.api.config.v1.Tree	track(org.polyfrost.oneconfig.api.config.v1.Tree registered)
static void	untrack(String treeId)
static void	withLiveValues(String id, Runnable action)	Runs action with the options of the config id holding what the user chose, see setLiveValueScope(java.util.function.BiConsumer<java.lang.String, java.lang.Runnable>)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.polyfrost.oneconfig.api.config.v1.ConfigManager.ProfileChangeListener

onProfileOperationFinished, onProfileSpecificControlsChanged, onProfileUnloading

Field Details

INSTANCE

public static final CompatSnapshots INSTANCE

SNAPSHOT_METADATA

public static final String SNAPSHOT_METADATA

See Also:

• Constant Field Values

CUSTOM_RESET_METADATA

public static final String CUSTOM_RESET_METADATA

See Also:

• Constant Field Values

KEY_METADATA

public static final String KEY_METADATA

See Also:

• Constant Field Values

NO_SNAPSHOT_META

public static final String NO_SNAPSHOT_META

See Also:

• Constant Field Values

GATE_METADATA

public static final String GATE_METADATA

See Also:

• Constant Field Values

Method Details

isApplying

public static boolean isApplying()

setDispatcher

public static void setDispatcher(Consumer<Runnable> dispatcher)

setLiveValueScope

@Internal
public static void setLiveValueScope(BiConsumer<String,Runnable> scope)

Sets what every read of the live option values runs inside
Lets whoever temporarily overwrites a mod's options put the user's own values back for the duration, so the substitutes are never mistaken for them

withLiveValues

@Internal
public static void withLiveValues(String id,
 Runnable action)

Runs action with the options of the config id holding what the user chose, see setLiveValueScope(java.util.function.BiConsumer<java.lang.String, java.lang.Runnable>)

register

public static org.polyfrost.oneconfig.api.config.v1.Tree register(org.polyfrost.oneconfig.api.config.v1.Tree tree)

track

public static org.polyfrost.oneconfig.api.config.v1.Tree track(org.polyfrost.oneconfig.api.config.v1.Tree registered)

untrack

public static void untrack(String treeId)

onProfileChanged

public void onProfileChanged(String newProfile)

Specified by:

onProfileChanged in interface ConfigManager.ProfileChangeListener

onProfileSaving

public void onProfileSaving(String profile)

Specified by:

onProfileSaving in interface ConfigManager.ProfileChangeListener

onProfileCreated

public void onProfileCreated(String profile)

Specified by:

onProfileCreated in interface ConfigManager.ProfileChangeListener

onProfileRenamed

public void onProfileRenamed(String oldProfile,
 String newProfile)

Specified by:

onProfileRenamed in interface ConfigManager.ProfileChangeListener

onProfileDeleted

public void onProfileDeleted(String profile)

Specified by:

onProfileDeleted in interface ConfigManager.ProfileChangeListener

capture

public static void capture(org.polyfrost.oneconfig.api.config.v1.Tree tree)