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

Class ExprPotionEffects

java.lang.Object

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

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

org.skriptlang.skript.bukkit.potion.elements.expressions.ExprPotionEffects

All Implemented Interfaces:

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

@Name("Potion Effects of Entity/Item")
@Description({"An expression to obtain the active or hidden potion effects of an entity or item.","When an entity is affected by a potion effect but already has a weaker version of that effect type, the weaker version becomes hidden. If the weaker version has a longer duration, it returns after the stronger version expires.","NOTE: Hidden effects are not able to be changed.","NOTE: Clearing the base potion effects of a potion item is not possible. If you wish to do so, just set the item to a water bottle."})
@Example("set {_effects::*} to the active potion effects of the player") @Example("clear the player\'s hidden potion effects") @Example("add the potion effects of the player to the potion effects of the player\'s tool") @Example("reset the potion effects of the player\'s tool") @Example("remove speed and night vision from the potion effects of the player")
@RequiredPlugins("Paper 1.20.4+ for hidden effects")
@Since("2.5.2, INSERT VERSION (active/hidden support, more change modes)")
public class ExprPotionEffects
extends ch.njol.skript.expressions.base.PropertyExpression<Object,SkriptPotionEffect>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExprPotionEffects.State

Field Summary

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

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ExprPotionEffects()

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.
protected SkriptPotionEffect[]	get(org.bukkit.event.Event event, Object[] source)
Class<? extends SkriptPotionEffect>	getReturnType()	Gets the return type of this expression.
ExprPotionEffects.State	getState()
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
boolean	isSingle()
static void	register(SyntaxRegistry registry, 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, 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

ExprPotionEffects

public ExprPotionEffects()

Method Details

register

public static void register(SyntaxRegistry registry,
 Origin origin)

init

public boolean init(Expression<?>[] exprs,
 int matchedPattern,
 Kleenean isDelayed,
 SkriptParser.ParseResult parseResult)

Description copied from interface: SyntaxElement

Called just after the constructor and SyntaxElement.preInit().

Parameters:

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

Specified by:

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

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<SkriptPotionEffect>

Overrides:

acceptChange in class SimpleExpression<SkriptPotionEffect>

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<SkriptPotionEffect>

Overrides:

change in class SimpleExpression<SkriptPotionEffect>

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

isSingle

public boolean isSingle()

Specified by:

isSingle in interface Expression<SkriptPotionEffect>

Overrides:

isSingle in class ch.njol.skript.expressions.base.PropertyExpression<Object,SkriptPotionEffect>

Returns:

true if this expression will ever only return one value at most, false if it can return multiple values.

getReturnType

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

getState

@Internal
public ExprPotionEffects.State getState()