Class ExprTag
java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.Tag>
org.skriptlang.skript.bukkit.tags.elements.ExprTag
- All Implemented Interfaces:
Debuggable
,Expression<org.bukkit.Tag>
,Loopable<org.bukkit.Tag>
,SyntaxElement
,RuntimeErrorProducer
,SyntaxRuntimeErrorProducer
@Name("Tag")
@Description({"Represents a tag which can be used to classify items, blocks, or entities.","Tags are composed of a value and an optional namespace: \"minecraft:oak_logs\".","If you omit the namespace, one will be provided for you, depending on what kind of tag you\'re using. For example, `tag \"doors\"` will be the tag \"minecraft:doors\", while `paper tag \"doors\"` will be \"paper:doors\".","`minecraft tag` will search through the vanilla tags, `datapack tag` will search for datapack-provided tags (a namespace is required here!), `paper tag` will search for 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({"minecraft tag \"dirt\" # minecraft:dirt","paper tag \"doors\" # paper:doors","tag \"skript:custom_dirt\" # skript:custom_dirt","custom tag \"dirt\" # skript:dirt","datapack block tag \"dirt\" # minecraft:dirt","datapack tag \"my_pack:custom_dirt\" # my_pack:custom_dirt","tag \"minecraft:mineable/pickaxe\" # minecraft:mineable/pickaxe","custom item tag \"blood_magic_sk/can_sacrifice_with\" # skript:blood_magic_sk/can_sacrifice_with"})
@Since("2.10")
@RequiredPlugins("Paper (paper tags)")
@Keywords({"blocks","minecraft tag","type","category"})
public class ExprTag
extends SimpleExpression<org.bukkit.Tag>
implements SyntaxRuntimeErrorProducer
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected org.bukkit.Tag<?> @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)
.getNode()
Returns the sourceNode
for any errors the implementing class emits.Class
<? extends org.bukkit.Tag> Gets the return type of this expression.boolean
init
(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Called just after the constructor.boolean
isSingle()
Expression
<? extends org.bukkit.Tag> simplify()
Simplifies the expression, e.g.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, possibleReturnTypes, stream
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
-
ExprTag
public ExprTag()
-
-
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.- Specified by:
init
in interfaceSyntaxElement
- 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) 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<org.bukkit.Tag>
- Parameters:
event
- The event with which this expression is evaluated.- Returns:
- An array of values for this event. May not contain nulls.
-
isSingle
public boolean isSingle()- Specified by:
isSingle
in interfaceExpression<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.- Specified by:
getReturnType
in interfaceExpression<org.bukkit.Tag>
- Returns:
- A supertype of any objects returned by
Expression.getSingle(Event)
and the component type of any arrays returned byExpression.getArray(Event)
-
getNode
Description copied from interface:SyntaxRuntimeErrorProducer
Returns the sourceNode
for any errors the implementing class emits.
Used for accessing the line contents viaNode.getKey()
and the line number viaNode.getLine()
.
A standard implementation is to store the Node duringSyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult)
viaParserInstance.getNode()
.- Specified by:
getNode
in interfaceSyntaxRuntimeErrorProducer
- Returns:
- The source that produced a runtime error.
-
toString
- Specified by:
toString
in interfaceDebuggable
- 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<org.bukkit.Tag>
- Overrides:
simplify
in classSimpleExpression<org.bukkit.Tag>
- 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!
-