Package ch.njol.skript.lang

Class Effect

java.lang.Object
ch.njol.skript.lang.TriggerItem
ch.njol.skript.lang.Statement
ch.njol.skript.lang.Effect
All Implemented Interfaces:
Debuggable, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
Direct Known Subclasses:
AsyncEffect, EffAllowAging, EffBreedable, EffBrewingConsume, EffectSectionEffect, EffEquipCompDamageable, EffEquipCompDispensable, EffEquipCompInteract, EffEquipCompShearable, EffEquipCompSwapEquipment, EffFishingLure, EffGenerateLoot, EffMakeAdultOrBaby, EffPullHookedEntity, EffRegisterTag, EffRotate, EffTextDisplayDropShadow, EffTextDisplaySeeThroughBlocks
public abstract class Effect extends Statement implements SyntaxRuntimeErrorProducer
An effect which is unconditionally executed when reached, and execution will usually continue with the next item of the trigger after this effect is executed (the stop effect for example stops the trigger, i.e. nothing else will be executed after it)
See Also:

  • Constructor Details

    • Effect

      protected Effect()

  • Method Details

    • preInit

      public boolean preInit()
      Description copied from interface: SyntaxElement
      Called immediately after the constructor. This should be used to do any work that need to be done prior to downstream initialization. This is not intended to be used by syntaxes directly, but by parent classes to do work prior to the initialization of the child classes.
      Specified by:
      preInit in interface SyntaxElement
      Returns:
      Whether this expression was pre-initialised successfully. An error should be printed prior to returning false to specify the cause.

    • execute

      protected abstract void execute(org.bukkit.event.Event event)
      Executes this effect.
      Parameters:
      event - The event with which this effect will be executed

    • run

      public final boolean run(org.bukkit.event.Event event)
      Description copied from class: TriggerItem
      Executes this item.
      Specified by:
      run in class TriggerItem
      Parameters:
      event - The event to run this item with
      Returns:
      True if the next item should be run, or false for the item following this item's parent.

    • parse

      @Nullable public static @Nullable Effect parse(String input, @Nullable @Nullable String defaultError)

    • getNode

      public Node getNode()
      Description copied from interface: SyntaxRuntimeErrorProducer
      Returns the source Node for any errors the implementing class emits.
      Used for accessing the line contents via Node.getKey() and the line number via Node.getLine().
      A standard implementation is to store the Node during SyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult) via ParserInstance.getNode().
      Specified by:
      getNode in interface SyntaxRuntimeErrorProducer
      Returns:
      The source that produced a runtime error.

    • getSyntaxTypeName

      @NotNull public @NotNull String getSyntaxTypeName()
      Specified by:
      getSyntaxTypeName in interface SyntaxElement
      Returns:
      A string naming the type of syntax this is. e.g. "expression", "section".