Interface StoryBlitzChallenge

All Known Implementing Classes:
BellRingChallenge, BreakBlockChallenge, CraftItemChallenge, EmptyInventoryChallenge, HatSwitchChallenge, KillPlayerChallenge, LadderClimbChallenge, PunchPigChallenge, RidePigChallenge, ShearSheepChallenge, SnowballChallenge
public interface StoryBlitzChallenge
Represents a single challenge in StoryBlitz. Implement this interface to provide custom challenge logic.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    cleanup(List<org.bukkit.entity.Player> players)
    Called when the challenge ends (cleanup).
    String
    getDescription()
    Returns the description of the challenge, which is shown to players.
    default String
    getDescriptionWithGoob(String normalDescription)
    Returns a description with a chance to include "goob" for fun.
    boolean
    isCompleted(org.bukkit.entity.Player player)
    Checks if the player has completed the challenge.
    default void
    start(List<org.bukkit.entity.Player> players)
    Called when the challenge starts for the given players.

  • Method Details

    • getDescription

      String getDescription()
      Returns the description of the challenge, which is shown to players.
      Returns:
      The description of the challenge.

    • start

      default void start(List<org.bukkit.entity.Player> players)
      Called when the challenge starts for the given players.
      Parameters:
      players - The players in the game.

    • isCompleted

      boolean isCompleted(org.bukkit.entity.Player player)
      Checks if the player has completed the challenge.
      Parameters:
      player - The player to check.
      Returns:
      true if the player has completed the challenge, false otherwise.

    • cleanup

      default void cleanup(List<org.bukkit.entity.Player> players)
      Called when the challenge ends (cleanup).
      Parameters:
      players - The players in the game.

    • getDescriptionWithGoob

      default String getDescriptionWithGoob(String normalDescription)
      Returns a description with a chance to include "goob" for fun.
      Parameters:
      normalDescription - The normal description of the challenge.
      Returns:
      The modified description, possibly including "goob".