Interface PunishEvent

All Superinterfaces:

space.arim.omnibus.events.AsyncEvent, BasePunishEvent<DraftPunishment>, space.arim.omnibus.events.Cancellable, space.arim.omnibus.events.Event

public interface PunishEvent
extends BasePunishEvent<DraftPunishment>

Called when a staff member is enacting a punishment with standard punishment commands (/ban, /mute, etc.) For intercepting punishments created by layouts, see CalculatedPunishEvent

Method Summary

Modifier and Type	Method	Description
default DraftPunishment	getDraftPunishment()	Deprecated. The equivalent getter BasePunishEvent.getDraftSanction() should be preferred
default void	setDraftPunishment(DraftPunishment draftPunishment)	Deprecated. The equivalent setter BasePunishEvent.setDraftSanction(DraftSanction) should be preferred

Methods inherited from interface BasePunishEvent

getDraftSanction, setDraftSanction

Methods inherited from interface space.arim.omnibus.events.Cancellable

cancel, isCancelled

Method Details

getDraftPunishment

@Deprecated
default DraftPunishment getDraftPunishment()

Deprecated.

The equivalent getter BasePunishEvent.getDraftSanction() should be preferred

Gets the draft punishment which will be put into place.

The draft punishment includes the operator who is enacting this punishment, the victim who is being punished, and several other details.

Returns:

the draft punishment

setDraftPunishment

@Deprecated
default void setDraftPunishment(DraftPunishment draftPunishment)

Deprecated.

The equivalent setter BasePunishEvent.setDraftSanction(DraftSanction) should be preferred

Sets the draft punishment which will be put into place.
The draft punishment includes the operator who is enacting this punishment, the victim who is being punished, and several other details.

Parameters:

draftPunishment - the new draft punishment