Package ch.njol.skript.expressions

Class ExprPortal

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.block.Block>
ch.njol.skript.expressions.ExprPortal
All Implemented Interfaces:
Debuggable, Expression<org.bukkit.block.Block>, SyntaxElement
@Name("Portal") @Description("The blocks associated with a portal in the portal creation event.") @Examples({"on portal creation:","\tloop portal blocks:","\t\tbroadcast \"%loop-block% is part of a portal!\""}) @Since("2.4") @Events("portal_create") public class ExprPortal extends SimpleExpression<org.bukkit.block.Block>

  • Constructor Details

    • ExprPortal

      public ExprPortal()

  • Method Details

    • init

      public boolean init​(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parser)
      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)
      parser - 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.block.Block[] 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.block.Block>
      Parameters:
      e - The event
      Returns:
      An array of values for this event. May not contain nulls.

    • iterator

      public @Nullable Iterator<org.bukkit.block.Block> iterator​(org.bukkit.event.Event e)
      Description copied from interface: Expression
      Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
      Specified by:
      iterator in interface Expression<org.bukkit.block.Block>
      Overrides:
      iterator in class SimpleExpression<org.bukkit.block.Block>
      Parameters:
      e - The event
      Returns:
      An iterator to iterate over all values of this expression which may be empty and/or null, but must not return null elements.

    • isSingle

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

    • isDefault

      public boolean isDefault()
      Description copied from interface: Expression
      Returns whether this value represents the default value of its type for the event, i.e. it can be replaced with a call to event.getXyz() if one knows the event & value type.

      This method might be removed in the future as it's better to check whether value == event.getXyz() for every value an expression returns.

      Specified by:
      isDefault in interface Expression<org.bukkit.block.Block>
      Overrides:
      isDefault in class SimpleExpression<org.bukkit.block.Block>
      Returns:
      Whether is is the return types' default expression

    • getReturnType

      public Class<org.bukkit.block.Block> 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 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