Class HudEditorSetting.Toggle

java.lang.Object

com.render.api.HudEditorSetting.Toggle

All Implemented Interfaces:

HudEditorSetting

Enclosing interface:

HudEditorSetting

public static final class HudEditorSetting.Toggle
extends Object
implements HudEditorSetting

Named boolean toggle setting.

Nested Class Summary

Nested classes/interfaces inherited from interface HudEditorSetting

HudEditorSetting.Slider, HudEditorSetting.Toggle

Method Summary

Modifier and Type	Method	Description
void	apply(boolean value)	Applies a player-selected value through the binding.
String	name()	Returns the label shown beside the editor control.
boolean	value()	Returns the current value supplied by the binding.

Methods inherited from class Object

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

Method Details

name

public String name()

Description copied from interface: HudEditorSetting

Returns the label shown beside the editor control.

Specified by:

name in interface HudEditorSetting

Returns:

nonblank setting name

value

public boolean value()

Returns the current value supplied by the binding.

Returns:

current toggle value

apply

public void apply(boolean value)

Applies a player-selected value through the binding.

Parameters:

value - requested value