@occultus/random-api 0.20.0 → 0.21.0

package/README.md

@@ -3,6 +3,7 @@
 该 API 提供了生成随机事件与随机数、随机 UUID 的功能。
 
 ## EventList
+
 `EventList` 是一个用于管理加权事件列表的类，它允许根据权重随机触发事件，并返回触发结果的相关信息：
 
 ```typescript
@@ -18,10 +19,11 @@ const eventList = new EventList(eventData);
 
 // 调用事件
 const result = eventList.call();
-console.log(`触发事件索引: ${result.dataIndex}, 权重总和: ${result.weightSum}, 随机权重值: ${result.weightRand}`);
+console.log(
+  `触发事件索引: ${result.dataIndex}, 权重总和: ${result.weightSum}, 随机权重值: ${result.weightRand}`
+);
 ```
 
-
 ### `constructor(public data: EventListData[])`
 
 创建一个新的 EventList 实例
@@ -30,6 +32,7 @@ console.log(`触发事件索引: ${result.dataIndex}, 权重总和: ${result.wei
   - `data`: `EventListData[]` - 事件列表数据，包含事件及其对应的权重
 
 ### `call(): EventListResult`
+
 - **描述**: 调用事件，根据给定的权重决定触发何种事件
 - **返回值**: `EventListResult` - 包含事件触发结果的对象
   - `weightSum`: `number` - 所有事件权重的总和
@@ -38,6 +41,7 @@ console.log(`触发事件索引: ${result.dataIndex}, 权重总和: ${result.wei
 - **异常**: 如果找不到要调用的事件，会抛出 `OccultusSDKError` 异常
 
 ## Random
+
 `Random` 是一个提供随机数和 UUID 生成功能的工具类，包含生成随机整数、随机小数和 UUID 的静态方法：
 
 ```typescript
@@ -59,6 +63,7 @@ console.log(uuid); // 可能输出: "a1b2c3d4-e5f6-4g7h-i8j9-k0l1m2n3o4p5"
 ```
 
 ### `integer(max: number, min = 0, inclusive = true): number`
+
 生成指定范围内的随机整数
 
 - **参数**:
@@ -69,6 +74,7 @@ console.log(uuid); // 可能输出: "a1b2c3d4-e5f6-4g7h-i8j9-k0l1m2n3o4p5"
 - **异常**: 如果 `max < min`，则抛出 `RangeError`
 
 ### `decimal(max: number, min = 0, fixed = 2, inclusive = true): number`
+
 生成指定范围内的随机小数
 
 - **参数**:
@@ -80,16 +86,15 @@ console.log(uuid); // 可能输出: "a1b2c3d4-e5f6-4g7h-i8j9-k0l1m2n3o4p5"
 - **异常**: 如果 `max < min`，则抛出 `RangeError`
 
 ### `UUID(): string`
+
 生成一个 UUID
 
 - **返回值**: `string` - 一个字符串形式的 UUID
 
-
 ## RandomEvent
 
 `RandomEvent`是一个用于处理概率性事件触发的类，它允许根据设定的概率决定是否执行特定的事件函数：
 
-
 ```typescript
 // 创建一个有 30% 概率触发的事件
 const randomEvent = new RandomEvent(0.3, () => {
@@ -102,6 +107,7 @@ console.log(`事件是否被触发: ${triggered}`);
 ```
 
 ### `constructor(public chance: number, public event: () => void)`
+
 创建一个新的 RandomEvent 实例
 
 - **参数**:
@@ -109,8 +115,8 @@ console.log(`事件是否被触发: ${triggered}`);
   - `event`: `() => void` - 当事件被触发时执行的回调函数
 - **异常**: 如果提供的概率值无效，会抛出 `OccultusSDKError` 异常
 
-
 ### `call(): boolean`
+
 调用事件，根据给定的概率决定是否触发事件
 
 - **返回值**: `boolean` - 表示是否触发了事件的布尔值
@@ -142,4 +148,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@occultus/random-api",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"
@@ -24,14 +24,14 @@
   "license": "MIT",
   "author": "CTN Studios",
   "dependencies": {
-    "@occultus/math-api": "0.20.0"
+    "@occultus/math-api": "0.23.0"
   },
   "peerDependencies": {
-    "@minecraft/server": ">=2.0.0",
-    "@occultus/core": ">=0.18.4 || <0.19.0"
+    "@minecraft/server": "^2.4.0",
+    "@occultus/core": "^1.1.0"
   },
   "devDependencies": {
-    "typedoc": "^0.28.9"
+    "typedoc": "^0.28.16"
   },
   "scripts": {
     "test": "tsc"

package/src/api/EventList.ts

@@ -5,7 +5,7 @@ import { Random } from "./Random";
 
 /**
  * 一个用于管理加权事件列表的类，它允许根据权重触发随机事件，并返回触发结果的相关信息
- * 
+ *
  * @example
  * // 创建事件列表数据
  * const eventData: EventListData[] = [
@@ -28,7 +28,7 @@ export class EventList {
   constructor(public data: EventListData[]) {}
   /**
    * 调用事件，根据给定的权重决定触发何种事件
-   * 
+   *
    * **注意：如果所有事件权重都为 0，会导致无法触发任何事件**
    *
    * @returns 该函数运行的结果
@@ -55,7 +55,7 @@ export class EventList {
         return {
           weightSum: sum,
           weightRand: num,
-          dataIndex: i,
+          dataIndex: i
         };
       }
     }

package/src/api/RandomEvent.ts

@@ -9,11 +9,11 @@ import { Random } from "./Random";
  * const randomEvent = new RandomEvent(0.3, () => {
  *   console.log("事件被触发了！");
  * });
- * 
+ *
  * // 尝试触发事件
  * const triggered = randomEvent.call();
  * console.log(`事件是否被触发: ${triggered}`);
- * 
+ *
  */
 export class RandomEvent {
   /**
@@ -41,4 +41,3 @@ export class RandomEvent {
     return result;
   }
 }
-

package/src/index.ts

@@ -1,5 +1,8 @@
-export * from "./api/Random"
-export * from "./api/RandomEvent"
-export * from "./api/EventList"
-export * from "./interface/EventListData"
-export * from "./interface/EventListResult"
+/**
+ * @module @occultus/random-api
+ */
+export * from "./api/Random";
+export * from "./api/RandomEvent";
+export * from "./api/EventList";
+export * from "./interface/EventListData";
+export * from "./interface/EventListResult";

package/tsconfig.json

@@ -8,7 +8,7 @@
     "noEmit": true,
     "noEmitOnError": true,
     "target": "es2022",
-    "lib": ["es2020", "dom"],
+    "lib": ["es2021", "dom"],
     "strict": true,
     "moduleResolution": "bundler",
     "esModuleInterop": true,