up

Author: lgc2333

NavigationAPI.lls.js renamed to NavigationAPI.js

@@ -7,6 +7,23 @@ const exportNamespace = 'NavAPI';
 const tasks = new Map();
 const { Red, Green, Aqua, White, LightPurple, Clear, MinecoinGold } = Format;
 
+/**
+ * @typedef {Object} FloatPosObject
+ * @property {number} x
+ * @property {number} y
+ * @property {number} z
+ * @property {number} dimId
+ */
+/**
+ * @typedef {Object} Warp
+ * @property {FloatPosObject} pos
+ * @property {string} name
+ */
+
+/**
+ * @param {FloatPosObject} pos
+ * @returns {string}
+ */
 function formatPos(pos) {
   const { x, y, z, dimId } = pos;
   const dim = (() => {
@@ -32,8 +49,8 @@ function formatPos(pos) {
 /**
  * 停止导航任务
  *
- * @param {String} xuid 玩家Xuid
- * @returns {Boolean} 是否成功
+ * @param {string} xuid 玩家Xuid
+ * @returns {boolean} 是否成功
  */
 function clearNavigationTask(xuid) {
   const pl = mc.getPlayer(xuid);
@@ -53,8 +70,8 @@ function clearNavigationTask(xuid) {
 /**
  * 获取玩家是否正在导航中
  *
- * @param {String} xuid 玩家Xuid
- * @returns {Boolean} 玩家导航状态 true为正在导航
+ * @param {string} xuid 玩家Xuid
+ * @returns {boolean} 玩家导航状态 true为正在导航
  */
 function hasNavigationTask(xuid) {
   return !!tasks.get(xuid); // to boolean
@@ -63,24 +80,18 @@ function hasNavigationTask(xuid) {
 /**
  * 新建导航任务
  *
- * warp对象必须包含的项目示例
- * {
- *     "pos": {
- *         "x": 39.43924331665039,
- *         "y": 65.62001037597656,
- *         "z": 92.11305236816406,
- *         "dimId": 0
- *     },
- *     "name": "岩浆池"
- * }
- *
- * @param {String} xuid 玩家Xuid
- * @param {Object} warp warp对象，示例见上
- * @returns {Boolean} 是否成功
+ * @param {string} xuid 玩家Xuid
+ * @param {Warp} warp warp对象
+ * @returns {boolean} 是否成功
  */
 function newNavigationTask(xuid, warp) {
   const tmpPl = mc.getPlayer(xuid);
 
+  /**
+   * @param {number} x
+   * @param {number} z
+   * @returns {string}
+   */
   function formatXZPos(x, z) {
     return `${Green}${x.toFixed()} ${Red}~ ${Aqua}${z.toFixed()}`;
   }
@@ -99,7 +110,7 @@ function newNavigationTask(xuid, warp) {
     const { x: dx, y: dy, z: dz, dimId: dDim } = pos;
     const distance = Math.sqrt(
       (x - dx) * (x - dx) + (y - dy) * (y - dy) + (z - dz) * (z - dz)
-    ).toFixed(2);
+    );
 
     let msg =
       `${Green}${name}${Clear} | ` +
@@ -121,7 +132,9 @@ function newNavigationTask(xuid, warp) {
         return;
       }
 
-      msg += `${MinecoinGold}距离 ${Green}${distance} ${MinecoinGold}方块`;
+      msg +=
+        `${MinecoinGold}距离 ${Green}${distance.toFixed(2)} ` +
+        `${MinecoinGold}方块`;
     }
     pl.tell(msg, 5);
   }
@@ -135,7 +148,7 @@ function newNavigationTask(xuid, warp) {
 
 mc.listen('onLeft', (pl) => clearNavigationTask(pl.xuid));
 
-(() => {
+mc.listen('onServerStarted', () => {
   const cmd = mc.newCommand('stopnav', '停止导航', PermType.Any);
 
   cmd.setCallback((_, origin, out) => {
@@ -150,13 +163,13 @@ mc.listen('onLeft', (pl) => clearNavigationTask(pl.xuid));
 
   cmd.overload();
   cmd.setup();
-})();
+});
 
-ll.export(newNavigationTask, `${exportNamespace}_newTask`);
-ll.export(clearNavigationTask, `${exportNamespace}_clearTask`);
-ll.export(hasNavigationTask, `${exportNamespace}_hasTask`);
+ll.exports(newNavigationTask, `${exportNamespace}_newTask`);
+ll.exports(clearNavigationTask, `${exportNamespace}_clearTask`);
+ll.exports(hasNavigationTask, `${exportNamespace}_hasTask`);
 
-ll.registerPlugin(pluginName, '导航API', [0, 1, 2], {
+ll.registerPlugin(pluginName, '导航API', [0, 1, 3], {
   Author: 'student_2333',
   License: 'Apache-2.0',
 });

NavigationAPI_OldLXL.lls.js

@@ -21,13 +21,8 @@
 
 ### 引入
 
-我已经将插件上传到了我自己的服务器，用 `require` 声明依赖时填入我给出的 URL 即可免除腐竹装前置的烦恼
-
 ```js
-ll.require(
-  'NavigationAPI.lls.js',
-  'https://www.lgc2333.top/llse/NavigationAPI.min.lls.js'
-);
+ll.require('NavigationAPI');
 const newNavigationTask = ll.import('NavAPI_newTask');
 const clearNavigationTask = ll.import('NavAPI_clearTask');
 const hasNavigationTask = ll.import('NavAPI_hasTask');
@@ -91,10 +86,9 @@ function hasNavigationTask(xuid) {}
 
 ## 安装
 
-将 `NavigationAPI.lls.js` 扔进 BDS 插件目录即可  
-`NavigationAPI.min.lls.js`为我用 js 压缩工具得到的代码
-
-一般情况下如果插件开发者使用了我给出的 URL 作为前置依赖的远程下载链接，则**本插件不需要另外手动下载安装**
+```bash
+lip install github.com/lgc-LLDev/NavigationAPI
+```
 
 ## 配置文件
 
@@ -128,12 +122,13 @@ QQ：3076823485
 
 ## 更新日志
 
-**如果是自动下载的依赖，请删除`plugins/lib/NavigationAPI.lls.js`文件来更新！（旧版请删除`plugins/lib/NavigationAPI_OldLXL.lls.js`）**
+### 0.1.2
+
+- 修复坐标换算显示错误的 Bug
+- 适配旧版 lxl
+
+### 0.1.1
 
-- 0.1.1
-  - 修复了在末地时显示坐标换算的 Bug
-  - 修复玩家到地方不能结束导航
-  - 修改了指令`stopnavigation` -> `stopnav`
-- 0.1.2
-  - 修复坐标换算显示错误的 Bug
-  - 适配旧版 lxl
+- 修复了在末地时显示坐标换算的 Bug
+- 修复玩家到地方不能结束导航
+- 修改了指令 `stopnavigation` -> `stopnav`

README.md

@@ -1,20 +1,24 @@
 {
-  "format_version": 1,
-  "tooth": "github.com/lgc-LLSEDev/NavigationAPI",
-  "version": "0.1.2",
-  "dependencies": {},
-  "information": {
+  "$schema": "https://raw.githubusercontent.com/lippkg/lip/main/schemas/tooth.v2.schema.json",
+  "format_version": 2,
+  "tooth": "github.com/lgc-LLDev/NavigationAPI",
+  "version": "0.1.3",
+  "info": {
     "name": "NavigationAPI",
-    "description": "其他插件可对接的导航 API",
-    "author": "lgc2333",
-    "license": "Apache-2.0",
-    "homepage": "https://github.com/lgc-LLSEDev/NavigationAPI"
+    "description": "A navigation library",
+    "author": "student_2333",
+    "tags": ["library", "lse", "quickjs", "navigate", "navigation"]
   },
-  "placement": [
-    {
-      "source": "NavigationAPI.lls.js",
-      "destination": "plugins/lib/NavigationAPI.lls.js"
-    }
-  ],
-  "possession": []
+  "files": {
+    "place": [
+      {
+        "src": "NavigationAPI.js",
+        "dest": "plugins/NavigationAPI/NavigationAPI.js"
+      },
+      {
+        "src": "manifest.json",
+        "dest": "plugins/NavigationAPI/manifest.json"
+      }
+    ]
+  }
 }

tooth.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.template.json",
+  "include": ["*.js"],
+  "compilerOptions": {
+    "outDir": "./dist"
+  }
+}