EventJS
是 KubeJS 的一个附加模组,为 KubeJS 添加了可重载的原生事件。
使用 EventJS,你可以:
- 刷新你的原生事件监听器,而无需重启整个游戏;或将处理程序存储在
global['someId'] 中,这既更简单也更高效。
- 随意添加/移除原生事件监听器,而无需重新启动游戏(这在 KubeJS 1.16-1.20 中是不可能的)。
- 如果原生事件监听器中出现错误,防止游戏崩溃。
- 仅在服务器端或客户端侧添加事件监听器。
用法
默认情况下,EventJS 会替换原始的原生事件监听方法,使其支持重载。因此,你实际上不需要学习任何新东西就能使用 EventJS,只需安装它,你的 Forge 事件监听现在就可以重载了。
但是,如果你想要一些更动态且定义明确的事件监听,你可以使用 NativeEvents.onEvent(...) 和 NativeEvents.onGenericEvent(...) 进行通用事件监听。
NativeEvents 将在所有三种脚本类型(client/server/startup)中可用,因此你可以执行分侧事件监听。例如,在 client_scripts 中仅监听客户端事件,那么该事件监听就不会在服务器端发生。
语法 (v1.0.0~1.3.0)
NativeEvents.onEvent(eventType, handler)
NativeEvents.onEvent(priority, receiveCancelled, eventType, handler)
NativeEvents.onGenericEvent(genericClassFilter, eventType, handler)
NativeEvents.onGenericEvent(genericClassFilter, priority, receiveCancelled, eventType, handler)
JS 端的 handler 是一个接收事件的回调函数,例如:(event) => {...}
eventType 和 genericClassType 是能够表示某个类的内容,比如持有事件类名的字符串,或者通过 java(...) 或 Java.loadClass(...) 加载的事件类本身。
let handler: (event: AnyForgeEvent) => void
let eventType: string | Class
let genericClassFilter: string | Class
let priority: $EventPriority | "highest" | "high" | "normal" | "low" | "lowest"
let receiveCancelled: boolean
1.4.0 中的变更
在 EventJS 1.4.0 中,为了开箱即用支持 ProbeJS Legacy,eventType 和 genericClassFilter 将仅主动支持通过 java(...) (1.16.5) 或 Java.loadClass(...) (1.20.1) 加载的 Class。
let eventType: Class
let genericClassFilter: Class
支持的版本
1.0.0: 1.16.5
1.1.0: 1.16.5, 1.20.1
1.2.0: 1.16 到 1.20 之间的所有主要版本
你知道吗
我制作这个模组的原因是,KubeJS 在实现类似功能时效率极其低下。直到 KubeJS 更新到 1.21,它们才添加了原生事件监听器的重载功能,导致 1.16~1.20 的所有版本都被抛在后面。
用于 1.21+ 的 KubeJS 也包含对原生事件监听器重载的支持,使用了相同的名称 NativeEvents,但其实现方式与 EventJS 不同,因此请勿在对 EventJS 内部进行操作时通过 Java 做出假设。
EventJS
is a KubeJS addon that adds reloadable native events for KubeJS.
With EventJS, you can
- refresh your native event listeners without restarting the whole game or store the handler within a
global['someId'], which is both simpler and more performant.
- add/remove native event listeners as you like without relaunching, which was impossible in KubeJS for 1.16-1.20
- prevent your game from crashing if something goes wrong in your native event listener
- add event listener only in server/client side
Usage
By default, EventJS will replace the original native event listening method to make it reloadable. So you actually don't need to learn anything new in order to use EventJS, just install it and you Forge event listening is reloadable now.
But, if you're looking for some more dynamic and well-defined event listending, you can use NativeEvents.onEvent(...), and NativeEvents.onGenericEvent(...) for generic event listening.
NativeEvents will be avaliable for all 3 script types (client/server/startup), so you can perform sided event listening, that is, for example, listen to client-only event in client_scripts, then this event listening will not happen on server side.
Syntax (v1.0.0~1.3.0)
NativeEvents.onEvent(eventType, handler)
NativeEvents.onEvent(priority, receiveCancelled, eventType, handler)
NativeEvents.onGenericEvent(genericClassFilter, eventType, handler)
NativeEvents.onGenericEvent(genericClassFilter, priority, receiveCancelled, eventType, handler)
The handler in JS side, is a callback that receives the event, for example: (event) => {...}
The eventType and genericClassType is something that can represent a class, like a string that holds the event class name, or the event class itself loaded by java(...) or Java.loadClass(...).
let handler: (event: AnyForgeEvent) => void
let eventType: string | Class
let genericClassFilter: string | Class
let priority: $EventPriority | "highest" | "high" | "normal" | "low" | "lowest"
let receiveCancelled: boolean
Changes in 1.4.0
In EventJS 1.4.0, in order to support ProbeJS Legacy out of the box, the eventType and genericClassFilter will only actively support Class loaded via java(...) (1.16.5) or Java.loadClass(...) (1.20.1).
let eventType: Class
let genericClassFilter: Class
Supported Version
1.0.0: 1.16.5
1.1.0: 1.16.5, 1.20.1
1.2.0: all major version between 1.16 and 1.20
Do You Know That
The reason why I make this mod is that KubeJS is absurdly slow in implementing similar features. They added native event listener reloading only after KubeJS updated to 1.21, leaving all versions between 1.16~1.20 behind.
KubeJS for 1.21+ also contains support for native event listener reloading, using the same name NativeEvents, but its implementation is not the same as EventJS, so please dont make assumptions when interacting EventJS internals via Java.
评论 0
登录后参与评分
还没有评论,来抢沙发吧