Interface PostPunishEvent

All Superinterfaces:
space.arim.omnibus.events.AsyncEvent, space.arim.omnibus.events.Event, PostOpNotificationEvent
public interface PostPunishEvent extends space.arim.omnibus.events.AsyncEvent, PostOpNotificationEvent
Called after a punishment has been enacted
Author:
A248

  • Method Summary

    Modifier and Type
    Method
    Description
    Punishment
    getPunishment()
    Gets the punishment which was put into place.
    default Optional<String>
    getTarget()
    The command line target of the punishment.
    default boolean
    isSilent()
    If the punishment was issued silently.

  • Method Details

    • getPunishment

      Punishment getPunishment()
      Gets the punishment which was put into place.

      The punishment includes the operator who is enacting this punishment, the victim who is being punished, and several other details.
      Specified by:
      getPunishment in interface PostOpNotificationEvent
      Returns:
      the punishment

    • getTarget

      default Optional<String> getTarget()
      The command line target of the punishment. This is not necessarily the same as the punished victim (PunishmentBase.getVictim()), but rather the string argument interpreted to mean it.
      Specified by:
      getTarget in interface PostOpNotificationEvent
      Returns:
      the targeted user (victim name) on the command line, if available

    • isSilent

      default boolean isSilent()
      If the punishment was issued silently.
      Specified by:
      isSilent in interface PostOpNotificationEvent
      Returns:
      true if silent