Package ch.njol.skript.lang.function

Class Parameter<T>

java.lang.Object
ch.njol.skript.lang.function.Parameter<T>
All Implemented Interfaces:
Parameter<T>
@Deprecated(forRemoval=true, since="2.14") public final class Parameter<T> extends Object implements Parameter<T>
Deprecated, for removal: This API element is subject to removal in a future version.
Use ScriptParameter or DefaultFunction.Builder.parameter(String, Class, Modifier...) instead.

  • Field Details

    • PARAM_PATTERN

      public static final Pattern PARAM_PATTERN
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

  • Method Details

    • isOptional

      public boolean isOptional()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns whether this parameter is optional or not.
      Returns:
      Whether this parameter is optional or not.

    • getType

      @Deprecated(forRemoval=true, since="2.14") public ClassInfo<T> getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use type() instead.

    • newInstance

      @Deprecated(forRemoval=true, since="2.14") @Nullable public static <T> @Nullable Parameter<T> newInstance(String name, ClassInfo<T> type, boolean single, @Nullable @Nullable String def)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use ScriptParameter.parse(String, Class, String)} instead.

    • parse

      @Deprecated(forRemoval=true, since="2.14") @Nullable public static @Nullable List<Parameter<?>> parse(String args)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use
      invalid reference 
      ch.njol.skript.structures.StructFunction.FunctionParser#parse(String, String, String, String, boolean)
      instead.

    • getName

      @Deprecated(forRemoval=true, since="2.13") public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use name() instead.

    • getDefaultExpression

      @Nullable public @Nullable Expression<? extends T> getDefaultExpression()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the Expression that will be used to provide the default value of this parameter when the function is called.
      Returns:
      Expression that will provide default value of this parameter

    • isSingleValue

      public boolean isSingleValue()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get whether this parameter takes one or many values.
      Returns:
      True if this parameter takes one value, false otherwise

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object

    • toString

      public String toString(boolean debug)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • name

      @NotNull public @NotNull String name()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      name in interface Parameter<T>
      Returns:
      The name of this parameter.

    • type

      @NotNull public @NotNull Class<T> type()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      type in interface Parameter<T>
      Returns:
      The type of this parameter.

    • modifiers

      @NotNull public @Unmodifiable @NotNull Set<Parameter.Modifier> modifiers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      modifiers in interface Parameter<T>
      Returns:
      All modifiers belonging to this parameter.

    • isSingle

      public boolean isSingle()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      isSingle in interface Parameter<T>
      Returns:
      Whether this parameter is for single values.