Package cloud.commandframework.paper.argument

Class KeyedWorldArgument.Builder<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument.Builder<C,T>
cloud.commandframework.arguments.CommandArgument.TypedBuilder<C,org.bukkit.World,KeyedWorldArgument.Builder<C>>
cloud.commandframework.paper.argument.KeyedWorldArgument.Builder<C>
Type Parameters:
C - sender type
Enclosing class:
KeyedWorldArgument<C>
public static final class KeyedWorldArgument.Builder<C> extends cloud.commandframework.arguments.CommandArgument.TypedBuilder<C,org.bukkit.World,KeyedWorldArgument.Builder<C>>
Builder for KeyedWorldArgument.
Since:
1.6.0

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull KeyedWorldArgument.Builder<C>
    asOptionalWithDefault(@NonNull org.bukkit.NamespacedKey defaultValue)
    Sets the command argument to be optional, with the specified default value.
    @NonNull KeyedWorldArgument<C>
    build()
    Build a new KeyedWorldArgument.

    Methods inherited from class cloud.commandframework.arguments.CommandArgument.TypedBuilder

    asOptional, asOptionalWithDefault, asRequired, manager, self, withParser, withSuggestionsProvider

    Methods inherited from class cloud.commandframework.arguments.CommandArgument.Builder

    getDefaultDescription, getDefaultValue, getName, getParser, getSuggestionsProvider, getValueType, isRequired, withDefaultDescription

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • asOptionalWithDefault

      public @NonNull KeyedWorldArgument.Builder<C> asOptionalWithDefault(@NonNull org.bukkit.NamespacedKey defaultValue)
      Sets the command argument to be optional, with the specified default value.
      Parameters:
      defaultValue - default value
      Returns:
      this builder
      Since:
      1.6.0
      See Also:
      • CommandArgument.Builder.asOptionalWithDefault(String)

    • build

      public @NonNull KeyedWorldArgument<C> build()
      Build a new KeyedWorldArgument.
      Overrides:
      build in class cloud.commandframework.arguments.CommandArgument.Builder<C,org.bukkit.World>
      Returns:
      constructed argument
      Since:
      1.6.0