Package org.kingdoms.events

Class KingdomsEvent

java.lang.Object
org.bukkit.event.Event
org.kingdoms.events.KingdomsEvent
All Implemented Interfaces:
org.kingdoms.constants.namespace.NamespacedMetadataContainer, org.kingdoms.locale.provider.CascadingMessageContextProvider, org.kingdoms.locale.provider.MessageContextProvider
Direct Known Subclasses:
AsyncBatchLandLoadEvent, ChampionAbilityEvent, ClaimingEvent, GroupBannerChangeEvent, GroupColorChangeEvent, GroupHiddenStateChangeEvent, GroupHomeTeleportEvent, GroupRelationshipChangeEvent, GroupRenameEvent, GroupResourcePointConvertEvent, GroupShieldPurchaseEvent, KingdomBuildingFinishEvent, KingdomCreateEvent, KingdomDisbandEvent, KingdomGUIOpenEvent, KingdomInvadeAttackEvent, KingdomInvadeEndEvent, KingdomInvadeEvent, KingdomJoinEvent, KingdomKingChangeEvent, KingdomLeaveEvent, KingdomLoreChangeEvent, KingdomPacifismStateChangeEvent, KingdomPreInvadeEvent, KingdomsBlockEvent, LandChangeEvent, LandUnloadEvent, org.kingdoms.events.general.LocationChangeEvent, MailSendEvent, MassWarEndEvent, MassWarStartEvent, NationCreateEvent, NationDisbandEvent, NationJoinEvent, NationLeaveEvent, NexusMoveEvent, OpenProtectedBlockEvent, SiegeCannonHitEvent, TurretActivateEvent
public abstract class KingdomsEvent extends org.bukkit.event.Event implements org.kingdoms.constants.namespace.NamespacedMetadataContainer, org.kingdoms.locale.provider.CascadingMessageContextProvider
The abstract class of all Kingdoms plugin events. Simply adds metadata system to the default event system.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    org.bukkit.event.Event.Result

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.kingdoms.constants.namespace.Namespace
    SILENCED
    If an event has this namespace it shows that the event was prevented from being called at all, so no event listener would've received this event anyway.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KingdomsEvent()
     
    KingdomsEvent(boolean isAsync)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMessageContextEdits(@NotNull MessagePlaceholderProvider context)
     
    @Nullable org.bukkit.event.Event
    getCause()
     
    org.kingdoms.constants.namespace.NamespacedMap<Object>
    getMetadata()
     
    <T> @Nullable T
    getMetadata(@NonNull org.kingdoms.constants.namespace.Namespace namespace)
    Gets the value associated to the given namespace.
    boolean
    isSilenced()
     
    void
    silence(String name)
     

    Methods inherited from class org.bukkit.event.Event

    getEventName, getHandlers, isAsynchronous

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.kingdoms.locale.provider.CascadingMessageContextProvider

    getMessageContext

  • Field Details

    • SILENCED

      public static final org.kingdoms.constants.namespace.Namespace SILENCED
      If an event has this namespace it shows that the event was prevented from being called at all, so no event listener would've received this event anyway.

      The value of the metadata is recommended to be a string showing the name of the process/plugin/handler that silenced this event.

      An event that is Cancellable will always be in the cancelled state if it is silenced.

  • Constructor Details

    • KingdomsEvent

      public KingdomsEvent()

    • KingdomsEvent

      public KingdomsEvent(boolean isAsync)

  • Method Details

    • silence

      public void silence(String name)
      See Also:

    • isSilenced

      public boolean isSilenced()

    • getCause

      public @Nullable org.bukkit.event.Event getCause()

    • addMessageContextEdits

      public void addMessageContextEdits(@NotNull @NotNull MessagePlaceholderProvider context)
      Specified by:
      addMessageContextEdits in interface org.kingdoms.locale.provider.CascadingMessageContextProvider

    • getMetadata

      public org.kingdoms.constants.namespace.NamespacedMap<Object> getMetadata()
      Specified by:
      getMetadata in interface org.kingdoms.constants.namespace.NamespacedMetadataContainer
      See Also:
      • metadata

    • getMetadata

      public <T> @Nullable T getMetadata(@NonNull org.kingdoms.constants.namespace.Namespace namespace)
      Gets the value associated to the given namespace.
      Type Parameters:
      T - the expected type of the value.
      Parameters:
      namespace - the key of the value.
      Returns:
      the value or null if it doesn't exist.