Package ch.njol.skript.expressions

Class ExprMetadata<T>

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<T>
ch.njol.skript.expressions.ExprMetadata<T>
All Implemented Interfaces:
Debuggable, Expression<T>, SyntaxElement
@Name("Metadata") @Description("Metadata is a way to store temporary data on entities, blocks and more that disappears after a server restart.") @Examples({"set metadata value \"healer\" of player to true","broadcast \"%metadata value \"\"healer\"\" of player%\"","clear metadata value \"healer\" of player"}) @Since("2.2-dev36") public class ExprMetadata<T> extends SimpleExpression<T>

  • Constructor Details

    • ExprMetadata

      public ExprMetadata()

  • Method Details

    • init

      public boolean init​(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      Description copied from interface: SyntaxElement
      Called just after the constructor.
      Parameters:
      exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list holding the default value of the desired type which usually depends on the event.
      matchedPattern - The index of the pattern which matched
      isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
      parseResult - Additional information about the match.
      Returns:
      Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
      See Also:
      ParserInstance.isCurrentEvent(Class...)

    • get

      protected @Nullable T[] get​(org.bukkit.event.Event e)
      Description copied from class: SimpleExpression
      This is the internal method to get an expression's values.
      To get the expression's value from the outside use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).
      Specified by:
      get in class SimpleExpression<T>
      Parameters:
      e - The event
      Returns:
      An array of values for this event. May not contain nulls.

    • acceptChange

      public @Nullable Class<?>[] acceptChange​(Changer.ChangeMode mode)
      Description copied from interface: Expression
      Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

      Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

      Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

      Unlike Changer.acceptChange(ChangeMode) this method may print errors.

      Specified by:
      acceptChange in interface Expression<T>
      Overrides:
      acceptChange in class SimpleExpression<T>
      Returns:
      An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

    • change

      public void change​(org.bukkit.event.Event e, @Nullable Object[] delta, Changer.ChangeMode mode)
      Description copied from interface: Expression
      Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)
      Specified by:
      change in interface Expression<T>
      Overrides:
      change in class SimpleExpression<T>
      delta - An array with one or more instances of one or more of the the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.

    • isSingle

      public boolean isSingle()
      Returns:
      true if this expression will ever only return one value at most, false if it can return multiple values.

    • getReturnType

      public Class<? extends T> getReturnType()
      Description copied from interface: Expression
      Gets the return type of this expression.
      Returns:
      A supertype of any objects returned by Expression.getSingle(Event) and the component type of any arrays returned by Expression.getArray(Event)

    • getConvertedExpression

      public <R> Expression<? extends R> getConvertedExpression​(Class<R>... to)
      Description copied from class: SimpleExpression
      Usually, you want to override SimpleExpression.getConvertedExpr(Class[]). However, it may be useful to override this method if you have an expression with a return type that is unknown until runtime (like variables). Usually, you'll be fine with just the default implementation. This method is final on versions below 2.2-dev36.
      Specified by:
      getConvertedExpression in interface Expression<T>
      Overrides:
      getConvertedExpression in class SimpleExpression<T>
      Parameters:
      to - The desired return type of the returned expression
      Returns:
      The converted expression
      See Also:
      Converter, ConvertedExpression

    • getSource

      public Expression<?> getSource()
      Description copied from interface: Expression
      Returns the original expression that was parsed, i.e. without any conversions done.

      This method is undefined for simplified expressions.

      Specified by:
      getSource in interface Expression<T>
      Overrides:
      getSource in class SimpleExpression<T>
      Returns:
      The unconverted source expression of this expression or this expression itself if it was never converted.

    • toString

      public String toString​(@Nullable org.bukkit.event.Event e, boolean debug)
      Parameters:
      e - The event to get information to. This is always null if debug == false.
      debug - If true this should print more information, if false this should print what is shown to the end user
      Returns:
      String representation of this object