src/main/java/dev/isxander/yacl3/config/v2/api/autogen/FloatField.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

package dev.isxander.yacl3.config.v2.api.autogen;

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

/**
 * A regular option factory.
 * <p>
 * This creates a regular option with a
 * {@link dev.isxander.yacl3.api.controller.FloatFieldControllerBuilder} controller.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FloatField {
    /**
     * The minimum value of the field. If a user enters a value less
     * than this, it will be clamped to this value.
     * <p>
     * If this is set to {@code -Float.MAX_VALUE}, there will be no minimum.
     * <p>
     * If the current value is at this minimum, if available,
     * the translation key {@code yacl3.config.$configId.$fieldName.fmt.min}
     * will be used.
     */
    float min() default -Float.MAX_VALUE;

    /**
     * The maximum value of the field. If a user enters a value more
     * than this, it will be clamped to this value.
     * <p>
     * If this is set to {@code Float.MAX_VALUE}, there will be no minimum.
     * <p>
     * If the current value is at this maximum, if available,
     * the translation key {@code yacl3.config.$configId.$fieldName.fmt.max}
     * will be used.
     */
    float max() default Float.MAX_VALUE;

    /**
     * The format used to display the float.
     * This is the syntax used in {@link String#format(String, Object...)}.
     */
    String format() default "%.1f";
}