Class EffectSectionEffect

java.lang.Object
ch.njol.skript.lang.TriggerItem
ch.njol.skript.lang.Statement
ch.njol.skript.lang.Effect
ch.njol.skript.lang.EffectSectionEffect
All Implemented Interfaces:
Debuggable, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
public class EffectSectionEffect extends Effect
Represents the Effect aspect of an EffectSection. This allows for the use of EffectSections as effects, rather than just sections.

  • Constructor Details

    • EffectSectionEffect

      public EffectSectionEffect(EffectSection effectSection)

  • Method Details

    • 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:

    • 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

    • walk

      @Nullable protected @Nullable TriggerItem walk(org.bukkit.event.Event event)
      Description copied from class: TriggerItem
      Executes this item and returns the next item to run.

      Overriding classes must call TriggerItem.debug(Event, boolean). If this method is overridden, TriggerItem.run(Event) is not used anymore and can be ignored.

      Overrides:
      walk in class TriggerItem
      Parameters:
      event - The event
      Returns:
      The next item to run or null to stop execution

    • getIndentation

      public String getIndentation()
      Overrides:
      getIndentation in class TriggerItem

    • setParent

      public TriggerItem setParent(@Nullable @Nullable TriggerSection parent)
      Overrides:
      setParent in class TriggerItem

    • setNext

      public TriggerItem setNext(@Nullable @Nullable TriggerItem next)
      Overrides:
      setNext in class TriggerItem

    • getNext

      @Nullable public @Nullable TriggerItem getNext()
      Overrides:
      getNext in class TriggerItem

    • getActualNext

      @Nullable public @Nullable TriggerItem getActualNext()
      Description copied from class: TriggerItem
      This method guarantees to return next TriggerItem after this item. This is not always the case for TriggerItem.getNext(), for example, getNext() of a loop section usually returns itself.
      Overrides:
      getActualNext in class TriggerItem
      Returns:
      The next TriggerItem.

    • executionIntent

      @Nullable public @Nullable ExecutionIntent executionIntent()
      Description copied from class: TriggerItem
      Returns whether this item stops the execution of the current trigger or section(s).
      If present, and there are statement(s) after this one, the parser will print a warning to the user.

      Note: This method is used purely to print warnings and doesn't affect parsing, execution or anything else.

      Overrides:
      executionIntent in class TriggerItem
      Returns:
      whether this item stops the execution of the current trigger or section.

    • 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