Package net.lapismc.lapisbans.api.punishments.core

Interface PunishmentInterface

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void createPunishment()
      Creates the punishment in the database and adds it to the punishment manager, This may not implement the punishment in all cases (e.g.
      java.lang.String getAction()
      Returns the name of the punishment, e.g.
      java.lang.String getActioned()
      Returns the action this punishment makes e.g.
      java.util.UUID getAppliedBy()
      Get the UUID of the user who applied the punishment
      java.util.UUID getAppliedTo()
      Get the UUID of the player the punishment has been applied to
      java.lang.String getReason()
      Get the reason for this punishment
      java.lang.Long getStart()
      Get the system time when the punishment started
      PunishmentType getType()
      Get the type of punishment that this punishment object represents e.g.
      java.lang.String getUndo()
      Returns the undoing action for this punishment e.g.
      boolean isShadow()
      Is the punishment shadow, shadow punishments will not notify the player in any way
      void reversePunishment()
      Reverse the punishment This will disable the effects of the punishment and remove it from the database and history

    • Method Detail

      • getAppliedTo

        java.util.UUID getAppliedTo()
        Get the UUID of the player the punishment has been applied to
        Returns:
        Returns the UUID of the player that this punishment has been applied to

      • getAppliedBy

        java.util.UUID getAppliedBy()
        Get the UUID of the user who applied the punishment
        Returns:
        Returns the UUID of the user that applied this punishment

      • getReason

        java.lang.String getReason()
        Get the reason for this punishment
        Returns:
        Returns the reason that was given when this punishment was applied

      • isShadow

        boolean isShadow()
        Is the punishment shadow, shadow punishments will not notify the player in any way
        Returns:
        Returns true if this punishment is a shadow punishment, otherwise false

      • getStart

        java.lang.Long getStart()
        Get the system time when the punishment started
        Returns:
        Returns the time when the punishment started

      • createPunishment

        void createPunishment()
        Creates the punishment in the database and adds it to the punishment manager, This may not implement the punishment in all cases (e.g. bans wont kick players but mutes will be applied when this is called)

      • reversePunishment

        void reversePunishment()
        Reverse the punishment This will disable the effects of the punishment and remove it from the database and history

      • getActioned

        java.lang.String getActioned()
        Returns the action this punishment makes e.g. Ban would return Banned This is used for announcements
        Returns:
        The action this punishment takes

      • getUndo

        java.lang.String getUndo()
        Returns the undoing action for this punishment e.g. Ban would return Unbanned This is used for the pardon message announcement
        Returns:
        The undoing action for this punishment

      • getAction

        java.lang.String getAction()
        Returns the name of the punishment, e.g. Ban would return Ban
        Returns:
        Returns the name of the punishment