Class EffectSectionEffect

All Implemented Interfaces:
Debuggable, SyntaxElement

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

      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 TriggerSection parent)
      Overrides:
      setParent in class TriggerItem
    • setNext

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

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

      public String toString(@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