Package org.skriptlang.skript.bukkit.tags.elements

Class ExprTagContents

java.lang.Object

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

org.skriptlang.skript.bukkit.tags.elements.ExprTagContents

All Implemented Interfaces:

Debuggable, Expression<Object>, Loopable<Object>, Simplifiable<Expression<? extends Object>>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Tags Contents")
@Description({"Returns all the values that a tag contains.","For item and block tags, this will return items. For entity tags, it will return entity datas (a creeper, a zombie)."})
@Examples({"broadcast tag values of minecraft tag \"dirt\"","broadcast (first element of player\'s tool\'s block tags)\'s tag contents"})
@Since("2.10")
@Keywords({"blocks","minecraft tag","type","category"})
public class ExprTagContents
extends SimpleExpression<Object>

Constructor Summary

Constructors

Constructor	Description
ExprTagContents()

Method Summary

Modifier and Type	Method	Description
protected Object @Nullable []	get(org.bukkit.event.Event event)	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).
Class<?>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?> @NotNull [] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
boolean	isSingle()
Class<?>[]	possibleReturnTypes()	For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types.
Stream<?>	stream(org.bukkit.event.Event event)	Gets a non-null stream of this expression's values.
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

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

acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, simplify, supportsLoopPeeking, 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, canBeSingle, canReturn, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, streamAll

Methods inherited from interface org.skriptlang.skript.log.runtime.RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

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

getParser

Methods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

ExprTagContents

public ExprTagContents()

Method Details

init

public boolean init(Expression<?> @NotNull [] expressions,
 int matchedPattern,
 Kleenean isDelayed,
 SkriptParser.ParseResult parseResult)

Description copied from interface: SyntaxElement

Called just after the constructor and SyntaxElement.preInit().

Parameters:

expressions - 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 Object @Nullable [] 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<Object>

Parameters:

event - The event with which this expression is evaluated.

Returns:

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

stream

public Stream<?> stream(org.bukkit.event.Event event)

Description copied from interface: Expression

Gets a non-null stream of this expression's values.

Parameters:

event - The event

Returns:

A non-null stream of this expression's non-null values

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

possibleReturnTypes

public Class<?>[] possibleReturnTypes()

Description copied from interface: Expression

For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types. Use cases include: expressions that depend on the return type of their input.

Returns:

A list of all possible types this might return

toString

public String toString(@Nullable
 @Nullable org.bukkit.event.Event event,
 boolean debug)

Parameters:

event - The event to get information from. 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