Package ch.njol.skript.expressions

Class ExprFilter

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<Object>

ch.njol.skript.expressions.ExprFilter

All Implemented Interfaces:

Debuggable, Expression<Object>, SyntaxElement

@Name("Filter")
@Description("Filters a list based on a condition. For example, if you ran \'broadcast \"something\" and \"something else\" where [string input is \"something\"]\', only \"something\" would be broadcast as it is the only string that matched the condition.")
@Examples("send \"congrats on being staff!\" to all players where [player input has permission \"staff\"]")
@Since("2.2-dev36")
public class ExprFilter
extends SimpleExpression<Object>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExprFilter.ExprInput<T>

Constructor Summary

Constructors

Constructor	Description
ExprFilter()

Method Summary

Modifier and Type	Method	Description
protected Object[]	get(org.bukkit.event.Event e)	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).
Object	getCurrent()
static @Nullable ExprFilter	getParsing()
Class<?>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.
boolean	isLoopOf(String s)	Checks whether the given 'loop-...' expression should match this loop, e.g.
boolean	isSingle()
@NonNull Iterator<?>	iterator(org.bukkit.event.Event e)	Returns the same as Expression.getArray(Event) but as an iterator.
String	toString(org.bukkit.event.Event e, boolean debug)

Methods inherited from class ch.njol.skript.lang.util.SimpleExpression

acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, setTime, setTime, setTime, setTime, simplify, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.njol.skript.lang.Expression

beforeChange, stream

Methods inherited from interface ch.njol.skript.lang.SyntaxElement

getParser

Constructor Details

ExprFilter

public ExprFilter()

Method Details

getParsing

public static @Nullable ExprFilter getParsing()

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...)

iterator

public @NonNull Iterator<?> 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<Object>

Overrides:

iterator in class SimpleExpression<Object>

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.

get

protected Object[] 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<Object>

Parameters:

e - The event

Returns:

An array of values for this event. May not contain nulls.

getCurrent

public Object getCurrent()

getReturnType

public Class<?> 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)

isSingle

public boolean isSingle()

Returns:

true if this expression will ever only return one value at most, false if it can return multiple values.

toString

public String toString(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

isLoopOf

public boolean isLoopOf(String s)

Description copied from interface: Expression

Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an argument loop.

You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.

Specified by:

isLoopOf in interface Expression<Object>

Overrides:

isLoopOf in class SimpleExpression<Object>

Parameters:

s - The entered string

Returns:

Whether this loop matches the given string