Class ExprOfflinePlayers

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.OfflinePlayer>
ch.njol.skript.expressions.ExprOfflinePlayers
All Implemented Interfaces:
Debuggable, Expression<org.bukkit.OfflinePlayer>, SyntaxElement

@Name("Offline players") @Description("All players that have ever joined the server. This includes the players currently online.") @Examples("send \"Size of all players who have joined the server: %size of all offline players%\"") @Since("2.2-dev35") public class ExprOfflinePlayers extends SimpleExpression<org.bukkit.OfflinePlayer>
  • Constructor Details

    • ExprOfflinePlayers

      public ExprOfflinePlayers()
  • 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...)
    • 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.OfflinePlayer> 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)
    • get

      protected @Nullable org.bukkit.OfflinePlayer[] get(org.bukkit.event.Event event)
      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.OfflinePlayer>
      Parameters:
      event - The event
      Returns:
      An array of values for this event. May not contain nulls.
    • toString

      public String toString(@Nullable org.bukkit.event.Event event, boolean debug)
      Parameters:
      event - 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