Fzzy Config/me.fzzyhmstrs.fzzy_config.screen/ConfigScreenProvider

ConfigScreenProvider

@FunctionalInterface
fun interface ConfigScreenProvider

Provider of config screens for a particular namespace. This is used to provide custom screens in place of the default Fzzy Config implementation.

Register your implementation using ConfigApi.registerScreenProvider or ConfigApiJava.registerScreenProvider

This is one of two ways to disable the standard screen for a scope set; the other being registering a config using ConfigApi.registerAndLoadNoGuiConfig or ConfigApiJava.registerAndLoadNoGuiConfig, which would allow you to edit your config in a completely custom way not linked to the standard openScreen methods. The built in configs for keybinds and search settings use this method and open a custom popup instead.

Author

fzzyhmstrs

Since

0.7.0

Functions

Link copied to clipboard
open fun openScreen(namespace: String, scope: String): Boolean

Opens a Screen based on the provided scope. The default method simply opens the screen. You may want to reimplement this to, for example, pass the previous screen into the newly created screen so it can go back to that screen when it closes.

Link copied to clipboard
abstract fun provideScreen(namespace: String, scope: String): Screen?

Provides a Screen instance for use by something that may open it later (ModMenu for example). Return null if no relevant config screen should be opened.