mirror of https://github.com/cabaletta/baritone
55 lines
1.4 KiB
Java
55 lines
1.4 KiB
Java
/*
|
|
* This file is part of Baritone.
|
|
*
|
|
* Baritone is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Baritone is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Baritone. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package baritone.api.utils.interfaces;
|
|
|
|
/**
|
|
* @author Brady
|
|
* @since 8/20/2018
|
|
*/
|
|
public interface Toggleable {
|
|
|
|
/**
|
|
* Toggles the enabled state of this {@link Toggleable}.
|
|
*
|
|
* @return The new state.
|
|
*/
|
|
boolean toggle();
|
|
|
|
/**
|
|
* Sets the enabled state of this {@link Toggleable}.
|
|
*
|
|
* @return The new state.
|
|
*/
|
|
boolean setEnabled(boolean enabled);
|
|
|
|
/**
|
|
* @return Whether or not this {@link Toggleable} object is enabled
|
|
*/
|
|
boolean isEnabled();
|
|
|
|
/**
|
|
* Called when the state changes from disabled to enabled
|
|
*/
|
|
default void onEnable() {}
|
|
|
|
/**
|
|
* Called when the state changes from enabled to disabled
|
|
*/
|
|
default void onDisable() {}
|
|
}
|