Package org.skriptlang.skript.bukkit.particles.elements.expressions

Class ExprParticleWithOffset

java.lang.Object

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

ch.njol.skript.expressions.base.PropertyExpression<ParticleEffect,ParticleEffect>

org.skriptlang.skript.bukkit.particles.elements.expressions.ExprParticleWithOffset

All Implemented Interfaces:

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

@Name("Particle with Offset/Distribution/Velocity")
@Description("Applies a specific offset to a particle.\nOffsets are treated as distributions if particle count is greater than 0.\nOffsets are treated as velocity or some other special behavior if particle count is 0.\nSetting distribution/velocity with this method may change the particle count to 1/0 respectively.\n\nMore detailed information on particle behavior can be found at <a href=\"https://docs.papermc.io/paper/dev/particles/#count-argument-behavior\">Paper\'s particle documentation</a>.\n")
@Example("draw an electric spark particle with a velocity of vector(1,2,3) at player") @Example("draw 12 red dust particles with a distribution of vector(1,2,1) at player\'s head location")
@Since("2.14")
public class ExprParticleWithOffset
extends ch.njol.skript.expressions.base.PropertyExpression<ParticleEffect,ParticleEffect>

Field Summary

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

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ExprParticleWithOffset()

Method Summary

Modifier and Type	Method	Description
protected ParticleEffect[]	get(org.bukkit.event.Event event, ParticleEffect[] source)
Class<? extends ParticleEffect>	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(@NotNull SyntaxRegistry registry, @NotNull Origin origin)
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 ch.njol.skript.lang.util.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 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, returnNestedStructures, returnsNestedStructures, stream, streamAll

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

ExprParticleWithOffset

public ExprParticleWithOffset()

Method Details

register

public static void register(@NotNull
 @NotNull SyntaxRegistry registry,
 @NotNull
 @NotNull 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().

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 ParticleEffect[] get(org.bukkit.event.Event event,
 ParticleEffect[] source)

Specified by:

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

getReturnType

public Class<? extends ParticleEffect> 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