Class EffObjectives

All Implemented Interfaces:
Debuggable, SyntaxElement

@Name("Objectives") @Description("An effect to setup required objectives for JUnit tests to complete.") @NoDoc public class EffObjectives extends Effect
  • Constructor Details

    • EffObjectives

      public EffObjectives()
  • Method Details

    • init

      public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      Description copied from interface: SyntaxElement
      Called just after the constructor.
      Parameters:
      exprs - 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
    • toString

      public String toString(@Nullable org.bukkit.event.Event event, boolean debug)
      Parameters:
      event - The event to get information to. 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
    • isJUnitComplete

      public static boolean isJUnitComplete()
      Check if the currently running JUnit test has passed all it's required objectives that the script test setup.
      Returns:
      boolean true if the test passed.
    • getFailedObjectivesString

      public static String getFailedObjectivesString()
      Returns an array string containing all the objectives that the current JUnit test failed to accomplish in the given time.
      Returns: