Package com.griefdefender.api.permission.option

Interface OptionDefinition.Builder

Enclosing interface:
OptionDefinition
public static interface OptionDefinition.Builder

  • Method Details

    • enabled

      OptionDefinition.Builder enabled(boolean enabled)
      Whether this definition is enabled.
      Parameters:
      enabled -
      Returns:
      The builder

    • admin

      OptionDefinition.Builder admin(boolean value)
      Whether definition is for admin use only.
      Parameters:
      value -
      Returns:
      The builder

    • ownerMode

      OptionDefinition.Builder ownerMode(boolean value)
      Whether this definition supports managing owner and trusted.

      Note: This should only be true if a player can cause the option action(s).
      Parameters:
      value -
      Returns:
      The builder

    • group

      OptionDefinition.Builder group(String group)
      Sets the definition group.
      Parameters:
      group -
      Returns:
      The builder

    • preset

      OptionDefinition.Builder preset(String preset)
      Sets the preset.

      Note: It is recommended to use modid.
      Note: This is where all option definition and group information will be stored.
      Parameters:
      prest -
      Returns:
      The builder

    • defaultValue

      OptionDefinition.Builder defaultValue(String value)
      Sets the default value.
      Parameters:
      value - The default value
      Returns:
      The builder

    • optionData

      OptionDefinition.Builder optionData(OptionData data)
      Sets the option data.
      Parameters:
      data - The option data
      Returns:
      The builder

    • context

      OptionDefinition.Builder context(Context context)
      Sets the context.
      Parameters:
      context - The context
      Returns:
      The builder

    • contexts

      OptionDefinition.Builder contexts(Set<Context> contexts)
      Sets the contexts.
      Parameters:
      contexts - The contexts
      Returns:
      The builder

    • name

      OptionDefinition.Builder name(String name)
      Sets the definition name.
      Parameters:
      name - The definition name
      Returns:
      The builder

    • description

      OptionDefinition.Builder description(net.kyori.adventure.text.Component description)
      Sets the description.
      Parameters:
      description - The description
      Returns:
      The builder

    • groupDescription

      OptionDefinition.Builder groupDescription(net.kyori.adventure.text.Component description)
      Sets the group description.
      Parameters:
      description - The group description
      Returns:
      The builder

    • subject

      OptionDefinition.Builder subject(Subject subject)
      Sets the subject.
      Parameters:
      subject - The subject
      Returns:
      The builder

    • icon

      OptionDefinition.Builder icon(Icon icon)
      Sets the Icon.
      Parameters:
      icon - The icon
      Returns:
      The builder

    • reset

      OptionDefinition.Builder reset()
      Resets the builder to default settings.
      Returns:
      The builder

    • build

      OptionDefinition build()
      Returns the OptionDefinition.

      Note: The preset, group, and name MUST be a unique combination as it represents the definition id.
      Returns:
      The option definition