Class StructFunction

java.lang.Object
io.github.syst3ms.skriptparser.lang.event.SkriptEvent
io.github.syst3ms.skriptparser.lang.Structure
io.github.syst3ms.skriptparser.structures.functions.StructFunction
All Implemented Interfaces:
SyntaxElement
public class StructFunction extends Structure

  • Constructor Details

    • StructFunction

      public StructFunction()

  • Method Details

    • check

      public boolean check(TriggerContext ctx)
      Description copied from class: SkriptEvent
      Whether this event should trigger, given the TriggerContext
      Specified by:
      check in class SkriptEvent
      Parameters:
      ctx - the TriggerContext to check
      Returns:
      whether the event should trigger

    • init

      public boolean init(Expression<?>[] expressions, int matchedPattern, ParseContext parseContext)
      Description copied from interface: SyntaxElement
      Initializes this SyntaxElement before being used. This method is always called before all the others in an extending class, the only exception being CodeSection.loadSection(FileSection, ParserState, SkriptLogger).
      Specified by:
      init in interface SyntaxElement
      Overrides:
      init in class SkriptEvent
      Parameters:
      expressions - an array of expressions representing all the expressions that are being passed to this syntax element. As opposed to Skript, elements of this array can't be null.
      matchedPattern - the index of the pattern that was successfully matched. It corresponds to the order of the syntaxes in registration
      parseContext - an object containing additional information about the parsing of this syntax element, like regex matches and parse marks
      Returns:
      true if the syntax element was initialized successfully, false otherwise.
      See Also:

    • toString

      public String toString(TriggerContext ctx, boolean debug)
      Parameters:
      ctx - the event
      debug - whether to show additional information or not
      Returns:
      a String that should aim to resemble what is written in the script as closely as possible

    • getStringName

      public String getStringName()

    • register

      public void register(Trigger trigger)

    • addTrigger

      public void addTrigger(String scriptName, Trigger trigger)
      Overrides:
      addTrigger in class SkriptEvent

    • clearTrigger

      public void clearTrigger(String scriptName)
      Overrides:
      clearTrigger in class SkriptEvent