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>
,SyntaxElement
@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 -
Method Summary
Modifier and TypeMethodDescriptionprotected 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 useSimpleExpression.getSingle(Event)
orSimpleExpression.getArray(Event)
.Class
<?> Gets the return type of this expression.boolean
init
(Expression<?> @NotNull [] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Called just after the constructor.boolean
isSingle()
Class<?>[]
For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types.Expression
<?> simplify()
Simplifies the expression, e.g.Stream
<?> stream
(org.bukkit.event.Event event) Gets a non-null stream of this expression's values.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, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, setTime, 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
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser
-
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.- 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 matchedisDelayed
- 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:
-
get
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 useSimpleExpression.getSingle(Event)
orSimpleExpression.getArray(Event)
.- Specified by:
get
in classSimpleExpression<Object>
- Parameters:
event
- The event with which this expression is evaluated.- Returns:
- An array of values for this event. May not contain nulls.
-
stream
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
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 byExpression.getArray(Event)
-
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
- 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
-
simplify
Description copied from interface:Expression
Simplifies the expression, e.g. if it only contains literals the expression may be simplified to a literal, and wrapped expressions are unwrapped.After this method was used the toString methods are likely not useful anymore.
This method is not yet used but will be used to improve efficiency in the future.
- Specified by:
simplify
in interfaceExpression<Object>
- Overrides:
simplify
in classSimpleExpression<Object>
- Returns:
- A reference to a simpler version of this expression. Can change this expression directly and return itself if applicable, i.e. no references to the expression before this method call should be kept!
-