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

Class ExprParticleDistribution

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<org.bukkit.util.Vector>

ch.njol.skript.expressions.base.PropertyExpression<ParticleEffect,org.bukkit.util.Vector>

ch.njol.skript.expressions.base.SimplePropertyExpression<ParticleEffect,org.bukkit.util.Vector>

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

All Implemented Interfaces:

Debuggable, Expression<org.bukkit.util.Vector>, Loopable<org.bukkit.util.Vector>, Simplifiable<Expression<? extends org.bukkit.util.Vector>>, SyntaxElement, Converter<ParticleEffect,org.bukkit.util.Vector>, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Particle Distribution")
@Description("Determines the normal distribution that particles may be drawn within.\nThe distribution is defined by a vector of x, y, and z standard deviations.\n\nParticles will be randomly drawn based on these values, clustering towards the center. 68% of particles will be within 1 standard deviation, 95% within 2, and 99.7% within three.\nThe area the particles will spawn in can be roughly estimated as being within 2 times the standard deviation in each axis.\n\nFor example, a distribution of 1, 2, and 1 would spawn particles within roughly 2 blocks on the x and z axes, and within 4 blocks on the y axis.\n\nPlease note that distributions only take effect if the particle count is greater than 0!\nParticles with counts of 0 do not have distributions.\nIf the particle count is 0, the offset is treated differently depending on the particle.\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("set the particle distribution of {_my-particle} to vector(1, 2, 1)")
@Since("2.14")
public class ExprParticleDistribution
extends ch.njol.skript.expressions.base.SimplePropertyExpression<ParticleEffect,org.bukkit.util.Vector>

Field Summary

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

rawExpr

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

DEFAULT_PRIORITY

Fields inherited from interface org.skriptlang.skript.lang.converter.Converter

ALL_CHAINING, ALLOW_UNSAFE_CASTS, NO_CHAINING, NO_LEFT_CHAINING, NO_RIGHT_CHAINING

Constructor Summary

Constructors

Constructor	Description
ExprParticleDistribution()

Method Summary

Modifier and Type	Method	Description
Class<?> @Nullable []	acceptChange(Changer.ChangeMode mode)	Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.
void	change(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode)	Changes the expression's value by the given amount.
@Nullable org.bukkit.util.Vector	convert(ParticleEffect from)	Converts an object using this Converter.
protected String	getPropertyName()
Class<? extends org.bukkit.util.Vector>	getReturnType()	Gets the return type of this expression.
static void	register(@NotNull SyntaxRegistry registry, @NotNull Origin origin)

Methods inherited from class ch.njol.skript.expressions.base.SimplePropertyExpression

get, init, toString

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

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

ExprParticleDistribution

public ExprParticleDistribution()

Method Details

register

public static void register(@NotNull
 @NotNull SyntaxRegistry registry,
 @NotNull
 @NotNull Origin origin)

convert

@Nullable
public @Nullable org.bukkit.util.Vector convert(ParticleEffect from)

Description copied from interface: Converter

Converts an object using this Converter.

Specified by:

convert in interface Converter<ParticleEffect,org.bukkit.util.Vector>

Specified by:

convert in class ch.njol.skript.expressions.base.SimplePropertyExpression<ParticleEffect,org.bukkit.util.Vector>

Parameters:

from - The object to convert.

Returns:

The converted object.

acceptChange

public Class<?> @Nullable [] acceptChange(Changer.ChangeMode mode)

Description copied from interface: Expression

Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

Unlike Changer.acceptChange(ChangeMode) this method may print errors.

Specified by:

acceptChange in interface Expression<org.bukkit.util.Vector>

Overrides:

acceptChange in class SimpleExpression<org.bukkit.util.Vector>

Parameters:

mode - The mode to check

Returns:

An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

change

public void change(org.bukkit.event.Event event,
 Object @Nullable [] delta,
 Changer.ChangeMode mode)

Description copied from interface: Expression

Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)

Specified by:

change in interface Expression<org.bukkit.util.Vector>

Overrides:

change in class SimpleExpression<org.bukkit.util.Vector>

Parameters:

event - The event

delta - An array with one or more instances of one or more of the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.

mode - The Changer.ChangeMode of the attempted change

getReturnType

public Class<? extends org.bukkit.util.Vector> 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)

getPropertyName

protected String getPropertyName()

Specified by:

getPropertyName in class ch.njol.skript.expressions.base.SimplePropertyExpression<ParticleEffect,org.bukkit.util.Vector>