@occultus/article-api 0.24.0-beta.2 → 0.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@occultus/article-api",
-  "version": "0.24.0-beta.2",
+  "version": "0.24.0",
   "repository": {
     "type": "git",
     "url": "https://codeberg.org/TeamOccultus/StarTenonAPI"

package/src/api/Article.ts

@@ -90,7 +90,14 @@ export class Article extends FormLike {
           parseText(this.chapters![response.selection].title, player),
           parseText(this.chapters![response.selection].body, player)
         ];
-        const chapter = new Article("temp:chapter", chapterTitle, chapterBody);
+        const chapter = new Article(
+          "temp:chapter",
+          chapterTitle,
+          chapterBody,
+          undefined,
+          undefined,
+          false
+        );
         this.jumpTo(player, chapter, backTo);
       })
       .catch((err) => {

package/src/api/Bindings/ArticleServerBindings.ts

@@ -16,6 +16,9 @@ export type ArticleContent =
   | TextProvider
   | { chapter: ChapterData[]; description: TextProvider };
 
+/**
+ * 用于实现数据驱动组件绑定到服务端文章系统的类
+ */  
 export class ArticleServerBindings {
   private static instance: ArticleServerBindings | undefined;
   private static center: ArticleCenter | undefined;
@@ -90,6 +93,11 @@ export class ArticleServerBindings {
       this.registryArticleCenterContent(event, config);
     });
   }
+  /**
+   * 创建绑定
+   * @param config 
+   * @throws OccultusSDKError 如果已经创建过绑定
+   */
   static create(config: ArticleBindingConfig): void {
     if (ArticleServerBindings.instance) {
       throw new OccultusSDKError("ArticleServerBindings already created!");
@@ -125,6 +133,11 @@ export class ArticleServerBindings {
     }
     this.preloadedContent.set(id, content);
   }
+  /**
+   * 读取预载文章内容
+   * @param id 
+   * @return ID 对应的文章预载内容
+   */
   readPreloadedContent(
     id: string
   ):

package/src/api/Bindings/BindingConfig.ts

@@ -1,12 +1,37 @@
 import { RawMessage } from "@minecraft/server";
 
+/**
+ * 文章绑定配置
+ */
 export type ArticleBindingConfig = {
+  /**
+   * 主组件名称
+   */
   componentName: string;
+  /**
+   * 文章中心组件名称
+   */
   centerComponentName: string;
+  /**
+   * 文章内容组件名称
+   */
   contentComponentName: string;
+  /**
+   * 文章中心相关配置
+   */
   centerConfig: {
+    /**
+     * 文章标题
+     */
     title: RawMessage | string;
+    /**
+     * 文章描述
+     */
     description: RawMessage | string;
+    /**
+     * 文章的图标路径
+     * @example "textures/items/diamond"
+     */
     icon_path?: string;
   };
 };

package/src/api/Bindings/ComponentParams.ts

@@ -1,10 +1,23 @@
 import { RawMessage } from "@minecraft/server";
 
+/**
+ * 文章组件参数
+ */
 export type ArticleComponentParams = {
+  /**
+   * 文章标题
+   */
   title: RawMessage | string;
+  /**
+   * 文章图标路径
+   * @example "textures/items/diamond"
+   */
   icon_path?: string;
 };
 
+/**
+ * 文章内容组件参数
+ */
 export type ArticleContentParams = RawMessage[] | string;
 
 export type ArticleCenterComponentParams = {};