Package ch.njol.skript.expressions

Class ExprPotionEffects

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.potion.PotionEffect>
ch.njol.skript.expressions.ExprPotionEffects
All Implemented Interfaces:
Debuggable, Expression<org.bukkit.potion.PotionEffect>, SyntaxElement
@Name("Potion Effects") @Description({"Represents the active potion effects of entities and itemtypes.","You can clear all potion effects of an entity/itemtype and add/remove a potion effect/type to/from an entity/itemtype.","Do note you will not be able to clear the base potion effects of a potion item. In that case, just set the item to a water bottle.","When adding a potion effect type (rather than a potion effect), it will default to 15 seconds with tier 1."}) @Examples({"set {_p::*} to active potion effects of player","clear all the potion effects of player","clear all the potion effects of player\'s tool","add potion effects of player to potion effects of player\'s tool","add speed to potion effects of target entity","remove speed and night vision from potion effects of player"}) @Since("2.5.2") public class ExprPotionEffects extends SimpleExpression<org.bukkit.potion.PotionEffect>

  • Constructor Details

    • ExprPotionEffects

      public ExprPotionEffects()

  • 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 org.bukkit.potion.PotionEffect[] 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<org.bukkit.potion.PotionEffect>
      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<org.bukkit.potion.PotionEffect>
      Overrides:
      acceptChange in class SimpleExpression<org.bukkit.potion.PotionEffect>
      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<org.bukkit.potion.PotionEffect>
      Overrides:
      change in class SimpleExpression<org.bukkit.potion.PotionEffect>
      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 org.bukkit.potion.PotionEffect> 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)

    • toString

      public String toString​(@Nullable org.bukkit.event.Event e, boolean d)
      Parameters:
      e - The event to get information to. This is always null if debug == false.
      d - 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