Package org.skriptlang.skript.common.properties.expressions

Class PropExprWXYZ

java.lang.Object

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

org.skriptlang.skript.lang.properties.PropertyBaseExpression<WXYZHandler<?,?>>

org.skriptlang.skript.common.properties.expressions.PropExprWXYZ

All Implemented Interfaces:

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

public class PropExprWXYZ
extends PropertyBaseExpression<WXYZHandler<?,?>>

Field Summary

Fields inherited from class org.skriptlang.skript.lang.properties.PropertyBaseExpression

expr, properties, property, returnType, returnTypes, useCIP

Constructor Summary

Constructors

Constructor	Description
PropExprWXYZ()

Method Summary

Modifier and Type	Method	Description
WXYZHandler.Axis	axis()
@NotNull Property<WXYZHandler<?,?>>	getProperty()	Gets the property this expression represents.
String	getPropertyName()	Returns the name of the property for use in toString, e.g.
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
static void	register(SyntaxRegistry registry, Origin origin)

Methods inherited from class org.skriptlang.skript.lang.properties.PropertyBaseExpression

acceptChange, change, convert, get, getPropertyReturnTypes, getReturnType, isSingle, possibleReturnTypes, toString

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

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, returnNestedStructures, returnsNestedStructures, stream, streamAll

Methods inherited from interface org.skriptlang.skript.lang.properties.PropertyBaseSyntax

getBadTypesErrorMessage

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

PropExprWXYZ

public PropExprWXYZ()

Method Details

register

public static void register(SyntaxRegistry registry,
 Origin origin)

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().

Specified by:

init in interface SyntaxElement

Overrides:

init in class PropertyBaseExpression<WXYZHandler<?,?>>

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

axis

public WXYZHandler.Axis axis()

getProperty

@NotNull
public @NotNull Property<WXYZHandler<?,?>> getProperty()

Description copied from interface: PropertyBaseSyntax

Gets the property this expression represents. This is used to find the appropriate handlers for the expression's input types.

Returns:

The property this expression represents.

getPropertyName

public String getPropertyName()

Description copied from interface: PropertyBaseSyntax

Returns the name of the property for use in toString, e.g. "name", "display name", etc. Defaults to the PropertyBaseSyntax.getProperty()'s name, but can be overridden for custom names.

Returns:

The name of the property to use.