top.hendrixshen.magiclib.malilib.api.annotation.Hotkey Maven / Gradle / Ivy

Go to download

package top.hendrixshen.magiclib.malilib.api.annotation;

import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Binding hotkey for configuration.
 * This annotation is only valid when decorating {@link fi.dy.masa.malilib.config.options.ConfigHotkey}
 * instances and {@link fi.dy.masa.malilib.config.options.ConfigBooleanHotkeyed} instances.
 */
@Environment(EnvType.CLIENT)
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Hotkey {
    /**
     * Hotkey binding.
     *
     * @return A Key bind for configuration.
     */
    String hotkey() default "";
}