Package org.polyfrost.oneconfig.internal

Class OneConfigConfig

java.lang.Object

org.polyfrost.oneconfig.api.config.v1.Config

org.polyfrost.oneconfig.internal.OneConfigConfig

public class OneConfigConfig
extends org.polyfrost.oneconfig.api.config.v1.Config

Nested Class Summary

Nested classes/interfaces inherited from class org.polyfrost.oneconfig.api.config.v1.Config

org.polyfrost.oneconfig.api.config.v1.Config.Category

Field Summary

Fields

Modifier and Type	Field	Description
static float	animationTime
static float	customScale
static boolean	enableBackgroundBlur
static boolean	enableHudEditorSounds
static boolean	enableUIAmbience
static boolean	enableUIClickSounds
static boolean	enableUIMenuSounds
static boolean	enableUIMusicDucking
static boolean	enableUISliderSounds
static boolean	enableUISounds
static boolean	enableWindowBlur
static boolean	guiClosingAnimation
static boolean	guiOpenAnimation
static OneConfigConfig	INSTANCE	The live instance, used to persist programmatic changes (e.g.
static boolean	instantSearch
static org.polyfrost.oneconfig.api.ui.v1.keybind.OneConfigKeybind	oneConfigKeybind
static int	openingBehavior
static float	pageAnimationDuration
static boolean	pauseGame
static int	reducedResFilter
static int	searchDistance
static boolean	showFirstLaunchMessage
static boolean	showOpeningPageAnimation
static boolean	showOptionActionButtons
static boolean	showPageAnimations
static float	timeBeforeReset
static float	uiAmbienceVolume
static float	uiSharpening
static float	uiSoundVolume
static boolean	useCustomScale

Fields inherited from class org.polyfrost.oneconfig.api.config.v1.Config

category, iconPath, id, title, tree

Constructor Summary

Constructors

Constructor	Description
OneConfigConfig()

Method Summary

Modifier and Type	Method	Description
protected void	initialize(boolean byConfigManager)
static void	markFirstLaunchShown()	Called once after the first-launch message has been shown.
static void	setOpenAction(kotlin.jvm.functions.Function1<Boolean,Boolean> action)	Supplies the action run when the OneConfig keybind is pressed.

Methods inherited from class org.polyfrost.oneconfig.api.config.v1.Config

addAliases, addAliases, addCallback, addCallback, addDependency, addDependency, addDependency, addMigrationEntries, addMigrationEntry, addToInitQueue, captureDefaults, getProperty, getProperty, getTree, hideIf, hideIf, loadFrom, loadFrom, makeTree, preload, restoreDefaults, restoreProperty, save

Methods inherited from class java.lang.Object

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

Field Details

oneConfigKeybind

@Keybind(title="oneconfig.preferences.keybind.title",
         titleTranslation=true,
         subcategory="oneconfig.preferences.category.gui",
         subcategoryTranslation=true,
         description="oneconfig.preferences.keybind.description",
         descriptionTranslation=true)
public static org.polyfrost.oneconfig.api.ui.v1.keybind.OneConfigKeybind oneConfigKeybind

enableWindowBlur

@Switch(title="oneconfig.preferences.window_blur.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        description="oneconfig.preferences.window_blur.description",
        descriptionTranslation=true)
public static boolean enableWindowBlur

enableBackgroundBlur

@Switch(title="oneconfig.preferences.background_blur.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        description="oneconfig.preferences.background_blur.description",
        descriptionTranslation=true)
public static boolean enableBackgroundBlur

pauseGame

@Switch(title="oneconfig.preferences.pause_game.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        description="oneconfig.preferences.pause_game.description",
        descriptionTranslation=true)
public static boolean pauseGame

useCustomScale

@Switch(title="oneconfig.preferences.use_custom_scale.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        description="oneconfig.preferences.use_custom_scale.description",
        descriptionTranslation=true)
public static boolean useCustomScale

customScale

@Slider(title="oneconfig.preferences.custom_scale.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        min=0.5f,
        max=2.0f,
        step=0.05f,
        description="oneconfig.preferences.custom_scale.description",
        descriptionTranslation=true)
public static float customScale

reducedResFilter

@Dropdown(title="oneconfig.preferences.reduced_res_filter.title",
          titleTranslation=true,
          subcategory="oneconfig.preferences.category.gui",
          subcategoryTranslation=true,
          options={"oneconfig.preferences.reduced_res_filter.off","oneconfig.preferences.reduced_res_filter.sharpen","oneconfig.preferences.reduced_res_filter.harden"},
          optionsTranslation=true,
          description="oneconfig.preferences.reduced_res_filter.description",
          descriptionTranslation=true)
public static int reducedResFilter

uiSharpening

@Slider(title="oneconfig.preferences.ui_sharpening.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        min=0.0f,
        max=1.0f,
        step=0.05f,
        description="oneconfig.preferences.ui_sharpening.description",
        descriptionTranslation=true)
public static float uiSharpening

openingBehavior

@Dropdown(title="oneconfig.preferences.opening_behavior.title",
          titleTranslation=true,
          subcategory="oneconfig.preferences.category.gui",
          subcategoryTranslation=true,
          options={"oneconfig.mods","oneconfig.preferences","oneconfig.preferences.opening_behavior.previous_page","oneconfig.preferences.opening_behavior.smart_reset"},
          optionsTranslation=true,
          description="oneconfig.preferences.opening_behavior.description",
          descriptionTranslation=true)
public static int openingBehavior

showOpeningPageAnimation

@Switch(title="oneconfig.preferences.show_opening_page_animation.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        description="oneconfig.preferences.show_opening_page_animation.description",
        descriptionTranslation=true)
public static boolean showOpeningPageAnimation

instantSearch

@Switch(title="oneconfig.preferences.instant_search.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        description="oneconfig.preferences.instant_search.description",
        descriptionTranslation=true)
public static boolean instantSearch

showOptionActionButtons

@Switch(title="oneconfig.preferences.show_option_action_buttons.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        description="oneconfig.preferences.show_option_action_buttons.description",
        descriptionTranslation=true)
public static boolean showOptionActionButtons

timeBeforeReset

@Slider(title="oneconfig.preferences.time_before_reset.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.gui",
        subcategoryTranslation=true,
        min=5.0f,
        max=60.0f,
        description="oneconfig.preferences.time_before_reset.description",
        descriptionTranslation=true)
public static float timeBeforeReset

searchDistance

@Number(title="oneconfig.preferences.search_distance.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.search",
        subcategoryTranslation=true,
        min=0.0f,
        max=10.0f,
        description="oneconfig.preferences.search_distance.description",
        descriptionTranslation=true)
public static int searchDistance

guiOpenAnimation

@Switch(title="oneconfig.preferences.opening_animation.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.animations",
        subcategoryTranslation=true,
        description="oneconfig.preferences.opening_animation.description",
        descriptionTranslation=true)
public static boolean guiOpenAnimation

guiClosingAnimation

@Switch(title="oneconfig.preferences.closing_animation.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.animations",
        subcategoryTranslation=true,
        description="oneconfig.preferences.closing_animation.description",
        descriptionTranslation=true)
public static boolean guiClosingAnimation

animationTime

@Slider(title="oneconfig.preferences.opening_time.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.animations",
        subcategoryTranslation=true,
        min=0.05f,
        max=2.0f,
        step=0.05f,
        description="oneconfig.preferences.opening_time.description",
        descriptionTranslation=true)
public static float animationTime

showPageAnimations

@Switch(title="oneconfig.preferences.show_page_animations.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.animations",
        subcategoryTranslation=true,
        description="oneconfig.preferences.show_page_animations.description",
        descriptionTranslation=true)
public static boolean showPageAnimations

enableUISounds

@Switch(title="oneconfig.preferences.ui_sounds.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        description="oneconfig.preferences.ui_sounds.description",
        descriptionTranslation=true)
public static boolean enableUISounds

enableUIMenuSounds

@Switch(title="oneconfig.preferences.menu_sounds.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        description="oneconfig.preferences.menu_sounds.description",
        descriptionTranslation=true)
public static boolean enableUIMenuSounds

enableUIClickSounds

@Switch(title="oneconfig.preferences.click_sounds.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        description="oneconfig.preferences.click_sounds.description",
        descriptionTranslation=true)
public static boolean enableUIClickSounds

enableUISliderSounds

@Switch(title="oneconfig.preferences.slider_sounds.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        description="oneconfig.preferences.slider_sounds.description",
        descriptionTranslation=true)
public static boolean enableUISliderSounds

enableHudEditorSounds

@Switch(title="oneconfig.preferences.hud_editor_sounds.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        description="oneconfig.preferences.hud_editor_sounds.description",
        descriptionTranslation=true)
public static boolean enableHudEditorSounds

enableUIAmbience

@Switch(title="oneconfig.preferences.ui_ambience.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        description="oneconfig.preferences.ui_ambience.description",
        descriptionTranslation=true)
public static boolean enableUIAmbience

enableUIMusicDucking

@Switch(title="oneconfig.preferences.duck_music.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        description="oneconfig.preferences.duck_music.description",
        descriptionTranslation=true)
public static boolean enableUIMusicDucking

uiSoundVolume

@Slider(title="oneconfig.preferences.ui_sound_volume.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        min=0.0f,
        max=1.0f,
        step=0.05f,
        description="oneconfig.preferences.ui_sound_volume.description",
        descriptionTranslation=true)
public static float uiSoundVolume

uiAmbienceVolume

@Slider(title="oneconfig.preferences.ui_ambience_volume.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.sounds",
        subcategoryTranslation=true,
        min=0.0f,
        max=1.0f,
        step=0.05f,
        description="oneconfig.preferences.ui_ambience_volume.description",
        descriptionTranslation=true)
public static float uiAmbienceVolume

pageAnimationDuration

@Slider(title="oneconfig.preferences.page_animation_duration.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.animations",
        subcategoryTranslation=true,
        min=0.1f,
        max=0.6f,
        step=0.05f,
        description="oneconfig.preferences.page_animation_duration.description",
        descriptionTranslation=true)
public static float pageAnimationDuration

showFirstLaunchMessage

@Switch(title="oneconfig.preferences.show_first_launch_message.title",
        titleTranslation=true,
        subcategory="oneconfig.preferences.category.general",
        subcategoryTranslation=true,
        description="oneconfig.preferences.show_first_launch_message.description",
        descriptionTranslation=true)
public static boolean showFirstLaunchMessage

INSTANCE

public static OneConfigConfig INSTANCE

The live instance, used to persist programmatic changes (e.g. markFirstLaunchShown()).

Constructor Details

OneConfigConfig

public OneConfigConfig()

Method Details

initialize

protected void initialize(boolean byConfigManager)

Overrides:

initialize in class org.polyfrost.oneconfig.api.config.v1.Config

setOpenAction

public static void setOpenAction(kotlin.jvm.functions.Function1<Boolean,Boolean> action)

Supplies the action run when the OneConfig keybind is pressed. Called by the minecraft module, as the action references platform classes this module cannot depend on. See openAction.

markFirstLaunchShown

public static void markFirstLaunchShown()

Called once after the first-launch message has been shown. Flips showFirstLaunchMessage off and persists it so the message is not shown again until the user re-enables it from the menu.