Package de.z0rdak.yawp.core.flag

Interface IFlag

All Superinterfaces:
Comparable<IFlag>
All Known Implementing Classes:
BooleanFlag, Flag, IntFlag, ListFlag
public interface IFlag extends Comparable<IFlag>

  • Method Details

    • getName

      String getName()
      Get the unique identifier for the flag.
      The valid flags are currently stored as an enum.
      Mod:Name -> ResourceLocation in the future.
      Returns:
      unique name for flag.
      See Also:

    • getType

      FlagType getType()
      Returns the flag type of the flag. *
      Returns:
      the flag type enum value of the flag.
      See Also:

    • doesOverride

      boolean doesOverride()
      Returns whether the flag does override the same flag defined in child regions.
      Returns:
      true if the flag overrides the same flag in child regions

    • setOverride

      void setOverride(boolean doesOverride)
      Set the override state of the flag.
      When true, it overrides the same flag in child regions.
      Parameters:
      doesOverride - overrides the same flag in child regions if set to true

    • isActive

      boolean isActive()
      Returns whether the flag is active in the region.
      This means the flag state is either ALLOWED or DENIED.
      Disabled flags are not considered for flag checks.
      Returns:
      true if flag is active, false otherwise.

    • getState

      FlagState getState()

    • setState

      void setState(FlagState state)

    • getFlagMsg

      FlagMessage getFlagMsg()

    • setFlagMsg

      void setFlagMsg(FlagMessage msg)