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

Class EffPotionIcon

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

org.skriptlang.skript.bukkit.potion.elements.effects.EffPotionIcon

All Implemented Interfaces:

Debuggable, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Potion Effect - Icon")
@Description("Modify whether a potion effect shows an icon.")
@Example("hide the icon for the player\'s potion effects")
@Since("2.14")
public class EffPotionIcon
extends Effect

Field Summary

Fields inherited from class ch.njol.skript.lang.TriggerItem

parent

Constructor Summary

Constructors

Constructor	Description
EffPotionIcon()

Method Summary

Modifier and Type	Method	Description
protected void	execute(org.bukkit.event.Event event)	Executes this effect.
static String[]	getPatterns(org.skriptlang.skript.bukkit.potion.elements.effects.PotionPropertyEffect.Type type, String property)	Constructs and returns patterns for a potion property effect.
String	getPropertyName()
org.skriptlang.skript.bukkit.potion.elements.effects.PotionPropertyEffect.Type	getPropertyType()
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
void	modify(SkriptPotionEffect effect, boolean isNegated)	Modifies a property of a potion effect.
static void	register(SyntaxRegistry registry, Origin origin)
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

Methods inherited from class ch.njol.skript.lang.Effect

getNode, getSyntaxTypeName, parse, preInit, run

Methods inherited from class ch.njol.skript.lang.Statement

parse, parse

Methods inherited from class ch.njol.skript.lang.TriggerItem

debug, executionIntent, getActualNext, getIndentation, getNext, getParent, getTrigger, setNext, setParent, toString, walk, walk

Methods inherited from class java.lang.Object

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

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

EffPotionIcon

public EffPotionIcon()

Method Details

register

public static void register(SyntaxRegistry registry,
 Origin origin)

modify

public void modify(SkriptPotionEffect effect,
 boolean isNegated)

Modifies a property of a potion effect.

Parameters:

effect - The effect to modify.

isNegated - Whether the property is being negated (e.g., "not X").

getPropertyType

public org.skriptlang.skript.bukkit.potion.elements.effects.PotionPropertyEffect.Type getPropertyType()

Returns:

The type of property effect.

getPropertyName

public String getPropertyName()

Returns:

A name representing the potion property.

getPatterns

public static String[] getPatterns(org.skriptlang.skript.bukkit.potion.elements.effects.PotionPropertyEffect.Type type,
 String property)

Constructs and returns patterns for a potion property effect.

Parameters:

type - The type of property effect.

property - The potion property.

Returns:

Patterns completed by the provided type and property.

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

execute

protected void execute(org.bukkit.event.Event event)

Description copied from class: Effect

Executes this effect.

Specified by:

execute in class Effect

Parameters:

event - The event with which this effect will be executed

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