Package me.hackware.api.setting

Class SettingGroup

java.lang.Object

me.hackware.api.setting.Setting<Boolean>

me.hackware.api.setting.impl.BooleanSetting

me.hackware.api.setting.SettingGroup

public class SettingGroup
extends BooleanSetting

A group of settings that extends BooleanSetting.

When toggleable, left-click toggles the enabled state; when non-toggleable, it acts purely as a folder. Right-click always expands / collapses the children.

Usage:

 SettingGroup targets = addSetting(new SettingGroup("Targets")
         .add(new BooleanSetting("Players").defaultValue(true))
         .add(new BooleanSetting("Mobs").defaultValue(false)));

 SettingGroup shield = addSetting(new SettingGroup("Shield Break")
         .toggleable()
         .defaultValue(true)
         .add(new NumberSetting<Double>("Delay").defaultValue(0.5).min(0.0).max(2.0)));
 

Field Summary

Fields inherited from class me.hackware.api.setting.Setting

value

Constructor Summary

Constructors

Constructor	Description
SettingGroup(String name)
SettingGroup(String name, String description)

Method Summary

Modifier and Type	Method	Description
SettingGroup	add(Setting<?> child)	Adds a child setting to this group (fluent, returns the group).
<S extends Setting<?>> S	addSettings(S child)	Adds a child setting and returns the child (for storing a reference).
SettingGroup	defaultValue(Boolean defaultValue)
SettingGroup	description(String description)
SettingGroup	displayName(String displayName)
List<Setting<?>>	getChildren()
SettingGroup	group(String group)
boolean	hasVisibleChildren()	True if at least one direct child setting is currently visible.
boolean	isToggleable()
void	setOwner(SettingContainer owner)	When the group is assigned to a container, propagate ownership to all children so that child setValue() calls trigger config saves.
SettingGroup	toggleable()	Makes this group toggleable (left-click enables / disables).
SettingGroup	toggleable(boolean toggleable)
SettingGroup	visible(boolean visible)
SettingGroup	visible(BooleanSupplier visible)

Methods inherited from class me.hackware.api.setting.impl.BooleanSetting

onChanged, toggle

Methods inherited from class me.hackware.api.setting.Setting

get, getDefaultValue, getDescription, getDisplayName, getGroup, getName, getOwner, isBulkLoading, isVisible, setBulkLoadProbe, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

SettingGroup

public SettingGroup(String name)

SettingGroup

public SettingGroup(String name,
 String description)

Method Details

toggleable

public SettingGroup toggleable()

Makes this group toggleable (left-click enables / disables).

toggleable

public SettingGroup toggleable(boolean toggleable)

add

public SettingGroup add(Setting<?> child)

Adds a child setting to this group (fluent, returns the group).

addSettings

public <S extends Setting<?>> S addSettings(S child)

Adds a child setting and returns the child (for storing a reference).

displayName

public SettingGroup displayName(String displayName)

Overrides:

displayName in class BooleanSetting

defaultValue

public SettingGroup defaultValue(Boolean defaultValue)

Overrides:

defaultValue in class BooleanSetting

description

public SettingGroup description(String description)

Overrides:

description in class BooleanSetting

group

public SettingGroup group(String group)

Overrides:

group in class BooleanSetting

visible

public SettingGroup visible(boolean visible)

Overrides:

visible in class BooleanSetting

visible

public SettingGroup visible(BooleanSupplier visible)

Overrides:

visible in class BooleanSetting

setOwner

public void setOwner(SettingContainer owner)

When the group is assigned to a container, propagate ownership to all children so that child setValue() calls trigger config saves.

Overrides:

setOwner in class Setting<Boolean>

isToggleable

public boolean isToggleable()

getChildren

public List<Setting<?>> getChildren()

hasVisibleChildren

public boolean hasVisibleChildren()

True if at least one direct child setting is currently visible.