Package dev.scsupercraft.teamstages.data

Interface IGameStageData

All Superinterfaces:
net.darkhax.gamestages.data.IStageData
public interface IGameStageData extends net.darkhax.gamestages.data.IStageData
An extension of IStageData that replaces game stage's implementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addStage(String stage, @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
    Adds a stage to the unlocked stages collection matching the provided effect.
    void
    clear(@NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
    Clears all of the unlocked stages matching the provided effect.
    Collection<String>
    getStages(@NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
    Gets a collection of all unlocked stages matching the provided effect.
    boolean
    hasStage(String stage, @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
    Checks if a stage is unlocked matching the provided effect.
    void
    removeStage(String stage, @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
    Removes a stage from the unlocked stages collection matching the provided effect.

    Methods inherited from interface net.darkhax.gamestages.data.IStageData

    addStage, clear, getStages, hasStage, readFromNBT, removeStage, writeToNBT

  • Method Details

    • getStages

      Collection<String> getStages(@NotNull @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
      Gets a collection of all unlocked stages matching the provided effect.
      Parameters:
      effect - the affected stages
      Returns:
      a collection containing all of the unlocked stages.

    • hasStage

      boolean hasStage(@Nonnull String stage, @NotNull @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
      Checks if a stage is unlocked matching the provided effect.

      Both means either the player or the team needs the stage.

      Parameters:
      stage - The stage to check.
      effect - The affected stages.
      Returns:
      Whether or not the stage has been unlocked.

    • addStage

      void addStage(@Nonnull String stage, @NotNull @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
      Adds a stage to the unlocked stages collection matching the provided effect.
      Parameters:
      stage - The stage to unlock.
      effect - The affected stages.

    • removeStage

      void removeStage(@Nonnull String stage, @NotNull @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
      Removes a stage from the unlocked stages collection matching the provided effect.
      Parameters:
      stage - The stage to remove.
      effect - The affected stages.

    • clear

      void clear(@NotNull @NotNull dev.scsupercraft.teamstages.util.GameStageEffect effect)
      Clears all of the unlocked stages matching the provided effect.
      Parameters:
      effect - The affected stages.