Class ExprTagsOf
java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.Tag>
ch.njol.skript.expressions.base.PropertyExpression<Object,org.bukkit.Tag>
org.skriptlang.skript.bukkit.tags.elements.ExprTagsOf
- All Implemented Interfaces:
Debuggable
,Expression<org.bukkit.Tag>
,Loopable<org.bukkit.Tag>
,SyntaxElement
@Name("Tags of X")
@Description({"Returns all the tags of an item, block, or entity.","`minecraft tag` will return only the vanilla tags, `datapack tag` will return only datapack-provided tags, `paper tag` will return only Paper\'s custom tags (if you are running Paper), and `custom tag` will look in the \"skript\" namespace for custom tags you\'ve registered.","You can also filter by tag types using \"item\", \"block\", or \"entity\"."})
@Examples({"broadcast minecraft tags of dirt","send true if paper item tags of target block contains paper tag \"doors\"","broadcast the block tags of player\'s tool"})
@Since("2.10")
@RequiredPlugins("Paper (paper tags)")
@Keywords({"blocks","minecraft tag","type","category"})
public class ExprTagsOf
extends ch.njol.skript.expressions.base.PropertyExpression<Object,org.bukkit.Tag>
-
Field Summary
Fields inherited from class ch.njol.skript.expressions.base.PropertyExpression
DEFAULT_PRIORITY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected org.bukkit.Tag<?> @Nullable []
Class
<org.bukkit.Tag> Gets the return type of this expression.<T extends org.bukkit.Keyed>
Collection<org.bukkit.Tag<T>> getTags
(T value) Helper method for getting the tags of a value.boolean
init
(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Called just after the constructor.boolean
isSingle()
toString
(@Nullable org.bukkit.event.Event event, boolean debug) Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression
get, get, getAll, getAnd, getDefaultPatterns, getExpr, getPatterns, register, register, registerDefault, registerDefault, setExpr, simplify
Methods inherited from class ch.njol.skript.lang.util.SimpleExpression
acceptChange, change, check, check, check, 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, possibleReturnTypes, stream
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser
-
Constructor Details
-
ExprTagsOf
public ExprTagsOf()
-
-
Method Details
-
init
public boolean init(Expression<?>[] 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
protected org.bukkit.Tag<?> @Nullable [] get(org.bukkit.event.Event event, Object @NotNull [] source) - Specified by:
get
in classch.njol.skript.expressions.base.PropertyExpression<Object,
org.bukkit.Tag>
-
getTags
Helper method for getting the tags of a value.- Type Parameters:
T
- The type of the value.- Parameters:
value
- The value to get the tags of.- Returns:
- The tags the value is a part of.
-
isSingle
public boolean isSingle()- Specified by:
isSingle
in interfaceExpression<org.bukkit.Tag>
- Overrides:
isSingle
in classch.njol.skript.expressions.base.PropertyExpression<Object,
org.bukkit.Tag> - 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)
-
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
-