运行环境与常用对象
脚本引擎预置的对象,以及适合读取状态的常用接口。
本页目录
全局对象#
| 名称 | 用途 |
|---|---|
| script | 当前脚本生命周期回调 |
| polaris | 作弊模块、指令、IRC 提示与外挂运行信息 |
| render | 绘制、颜色与字体 |
| mc | 窗口尺寸、帧率和渲染插值 |
| player | 当前玩家状态与动作 |
| world | 实体与方块查询 |
| input | 游戏键位与鼠标状态 |
| network | 游戏连接状态和网络接口 |
| packet | 数据包包装接口 |
| web | 网络请求接口 |
| move | 移动相关接口 |
玩家、世界和服务器信息依赖当前游戏状态。在主菜单或刚退出世界时,不要假设仍然存在玩家或连接。
常用只读调用#
| 调用 | 结果 |
|---|---|
| polaris.getFPS() / mc.getFPS() | 当前 FPS |
| polaris.getSystemMillis() | 当前系统时间,毫秒 |
| mc.getDisplayWidth() / mc.getDisplayHeight() | 窗口像素宽高 |
| mc.getPartialTicks() / mc.getRenderPartialTicks() | 游戏更新与渲染插值 |
| player.getName() | 当前玩家名称 |
| player.isOnGround() / player.isMoving() | 着地或移动状态 |
| player.getBPS() | 当前移动速度信息 |
| player.getHeldItemStack() | 当前手持物品包装对象 |
| player.getGUI() | 当前界面名称 |
| world.getEntities() | 世界实体包装对象数组 |
| world.newBlockPos(x, y, z) | 创建方块位置对象 |
| world.getBlockName(blockPos) | 读取该位置方块名称 |
| network.isSingleplayer() / network.isMultiplayer() | 单人或多人连接状态 |
| network.getServerIP() / network.getServerName() | 当前服务器地址与名称 |
读取输入#
| 调用 | 结果 |
|---|---|
| input.isKeyBindForwardDown() | 游戏前进键是否按下 |
| input.isKeyBindJumpDown() | 游戏跳跃键是否按下 |
| input.isKeyBindSneakDown() | 游戏潜行键是否按下 |
| input.isKeyBindAttackDown() | 游戏攻击键是否按下 |
| input.isKeyBindUseItemDown() | 游戏使用物品键是否按下 |
| input.isKeyDown(keyCode) | 指定键盘键码是否按下 |
| input.isMouseDown(button) | 指定鼠标键是否按下 |
游戏键位读取跟随 Minecraft 中的绑定。具体键码和鼠标索引来自运行时输入接口;读取状态不会替用户修改游戏键位。
脚本兼容性#
外挂脚本引擎基于 Java 8 Nashorn,不是浏览器或 Node.js。window、document、require 和 npm 包不是这些预置 API。优先使用本节列出的对象,并从可运行的完整示例开始。
Java 类反射受内置安全白名单过滤;搬运其他外挂端脚本或 ES6+ 语法时,需按当前 API 适配。