Register your flags

Description

Since v1.0.5, you now can register your flag.

How-To

To register your flag, you need to create a CustomFlag object first.

The structure of CustomFlag will be shown below:

package io.github.lijinhong11.protector.api.flag;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * The custom flag object
 * @param namespace the namespace for verify
 * @param id the flag ID
 * @param defaultValue the default value
 * @param displayName the display name of the flag (optional)
 * @param description the description about the flag (optional)
 */
public record CustomFlag(@NotNull String namespace, @NotNull String id, boolean defaultValue, @Nullable String displayName, @Nullable String description) {
}

After creating the custom flag object, you can register it.

CustomFlag flag = ...;
ProtectorAPI.registerFlag(flag);