文档外挂脚本开发

生命周期与 Tick/发包事件

脚本负责向核心注册自定义作弊模块,模块开启后直接接管渲染、Motion 与发包事件。

本页目录

脚本生命周期#

回调调用时机
script.handle("onLoad", function () { … })顶层脚本执行完成后调用一次
script.handle("onUnload", function () { … })卸载或重载时调用,用于注销模块和命令

在脚本顶层注册生命周期回调。在 onLoad 中创建模块;在 onUnload 中调用自己创建对象的 unregister()。只关闭模块,不会把模块从列表中移除。

模块生命周期#

回调调用时机
module.handle("onEnable", function () { … })模块由关闭变为开启
module.handle("onDisable", function () { … })模块由开启变为关闭
module.handle("onRender2D", function (event) { … })已启用模块收到二维绘制事件

常规游戏事件只分发给已启用的脚本模块。文件显示 loaded,说明脚本求值完成;还需要启用该脚本创建的模块。回调名称区分大小写。

游戏事件表#

下表列出当前脚本包装层提供的事件名和该事件额外暴露的方法。标记可取消的事件还提供 isCancelled() 与 setCancelled(boolean)。

事件名事件对象方法可取消
onAttackgetTarget()是
onChatInputgetMessage()是
onClick无额外字段否
onGame无额外字段否
onHitSlowDownsetSlowDown(double)、setSprint(boolean)、getSlowDown()、isSprint()否
onJumpsetJumpMotion(float)、setYaw(float)、getJumpMotion()、getYaw()是
onKeyboardInputgetKey()否
onKillgetEntity()否
onModuleTogglegetModule()否
onMovesetX(double)、setY(double)、setZ(double)、getX()、getY()、getZ()是
onMoveInputsetForward(float)、setStrafe(float)、setJump(boolean)、setSneak(boolean)、setSneakSlowDownMultiplier(double)、getForward()、getStrafe()、isJump()、isSneak()、getSneakSlowDownMultiplier()否
onPacketReceivegetPacketName()、getPacketClassName()、isPacket(String)、getPacket()是
onPacketSendgetPacketName()、getPacketClassName()、isPacket(String)、getPacket()是
onPostMotion无额外字段否
onPreMotionsetPosX(double)、setPosY(double)、setPosZ(double)、setYaw(float)、setPitch(float)、setOnGround(boolean)、setSprinting(boolean)、getPosX()、getPosY()、getPosZ()、getYaw()、getPitch()、isOnGround()、isSprinting()是
onPreUpdate无额外字段否
onRender2DgetPartialTicks()、getScaledWidth()、getScaledHeight()、getScaleFactor()否
onRender3DgetPartialTicks()否
onServerJoingetIp()、getPort()否
onServerKickgetReason()否
onSlowDownsetStrafeMultiplier(float)、setForwardMultiplier(float)、getStrafeMultiplier()、getForwardMultiplier()是
onStrafesetForward(float)、setStrafe(float)、setFriction(float)、setYaw(float)、getForward()、getStrafe()、getFriction()、getYaw()、setSpeed(double, double)、setSpeed(double)是
onTick无额外字段否
onWatersetWater(boolean)、isWater()否
onWorldChange无额外字段否

常用绘制事件#

onRender2D 使用游戏缩放坐标。getScaledWidth() / getScaledHeight() 是当前逻辑宽高;getScaleFactor() 是界面缩放因子;getPartialTicks() 是帧内插值。onRender3D 提供 getPartialTicks(),用于世界绘制时的插值。

清理与重载#

重载会重新执行脚本并创建新的对象。旧模块若未注销,可能留下重复条目或事件回调。不要在高频回调里反复注册模块,也不要在绘制回调中持续发送通知;一次性提示可放在 onEnable 中。