Annotation Interface BridgeMapping


@Documented @Target(METHOD) @Retention(RUNTIME) public @interface BridgeMapping
事件桥接映射注解

用于标记事件桥接方法,定义从 Bukkit 事件到自定义事件的映射规则。 该注解必须与 AutoBridge 配合使用。

Since:
1.0.0
Version:
1.0.0
Author:
Berry_so
See Also:
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    是否异步发布转换后的自定义事件
    boolean
    是否忽略已取消的 Bukkit 事件
    org.bukkit.event.EventPriority
    Bukkit 事件监听器的优先级
    boolean
    是否同时发布原始的 Bukkit 事件
    Class<? extends org.bukkit.event.Event>
    源 Bukkit 事件类型
  • Element Details

    • source

      Class<? extends org.bukkit.event.Event> source
      源 Bukkit 事件类型

      通常会自动从方法参数推断,无需手动指定。 仅在特殊情况下(如方法有多个参数)才需要显式指定。

      Returns:
      Bukkit 事件类型
      Default:
      org.bukkit.event.Event.class
    • priority

      org.bukkit.event.EventPriority priority
      Bukkit 事件监听器的优先级

      决定桥接监听器在 Bukkit 事件处理链中的执行顺序。

      Returns:
      事件优先级,默认为 NORMAL
      Default:
      NORMAL
    • async

      boolean async
      是否异步发布转换后的自定义事件

      设置为 true 时,转换后的事件会异步发布到事件总线, 不会阻塞 Bukkit 事件处理线程。

      Returns:
      是否异步发布,默认为 false
      Default:
      false
    • publishOriginal

      boolean publishOriginal
      是否同时发布原始的 Bukkit 事件

      设置为 true 时,除了发布转换后的自定义事件外, 还会将原始的 Bukkit 事件也发布到事件总线。

      Returns:
      是否同时发布原始事件,默认为 false
      Default:
      false
    • ignoreCancelled

      boolean ignoreCancelled
      是否忽略已取消的 Bukkit 事件

      设置为 true 时,如果 Bukkit 事件已被取消(isCancelled), 则不会触发桥接转换和事件发布。

      Returns:
      是否忽略已取消的事件,默认为 false
      Default:
      false