Class ExprAllPersistentDataKeys

java.lang.Object

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

ch.njol.skript.expressions.base.PropertyExpression<Object,String>

org.skriptlang.skript.bukkit.pdc.elements.expressions.ExprAllPersistentDataKeys

All Implemented Interfaces:

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

@Name("All Persistent Data Keys")
@Description("Returns all persistent data keys stored in the specified objects.\nThis is not limited to tags set by Skript, but includes all keys regardless of their origin.\n")
@Example("set {_keys::*} to persistent data keys of player's tool\nif size of {_keys::*} > 0:\n    broadcast \"The tool has the following persistent data keys: %{_keys::*}%\"\nelse:\n    broadcast \"The tool has no persistent data keys.\"\n") @Example("for each {_key} in persistent data keys of player's tool:\n    broadcast \"Persistent data tag %{_key}%: %data tag {_key} of player's tool%\"\n")
@Since("2.15")
@Keywords({"pdc","persistent data container","custom data","nbt"})
public class ExprAllPersistentDataKeys
extends ch.njol.skript.expressions.base.PropertyExpression<Object,String>

Field Summary

Fields inherited from class ch.njol.skript.expressions.base.PropertyExpression

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ExprAllPersistentDataKeys()

Method Summary

Modifier and Type	Method	Description
protected String[]	get(org.bukkit.event.Event event, Object[] source)
Class<String>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
static void	register(SyntaxRegistry registry)
String	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, infoBuilder, isSingle, register, register, registerDefault, registerDefault, setExpr, simplify

Methods inherited from class SimpleExpression

acceptChange, change, check, check, check, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, supportsLoopPeeking, toString

Methods inherited from class Object

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

Methods inherited from interface Expression

beforeChange, canBeSingle, canReturn, canReturnAnyOf, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, possibleReturnTypes, returnNestedStructures, returnsNestedStructures, stream, streamAll

Methods inherited from interface RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

Methods inherited from interface SyntaxElement

getParser

Methods inherited from interface SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

ExprAllPersistentDataKeys

public ExprAllPersistentDataKeys()

Method Details

register

public static void register(SyntaxRegistry registry)

init

public boolean init(Expression<?>[] 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 String[] get(org.bukkit.event.Event event,
 Object[] source)

Specified by:

get in class ch.njol.skript.expressions.base.PropertyExpression<Object,String>

getReturnType

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

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