@emyrk/chronicle-panel-sdk (英语)

TypeScript 合同和二进制事件流帮助器用于信任的"纪事"自定义面板.

安装

pnpm add @emyrk/chronicle-panel-sdk

主机 API

import type {
  ChroniclePanelPluginV1,
  ChroniclePanelSnapshotV1,
} from "@emyrk/chronicle-panel-sdk/v1";

快照包括实例和相遇时间,日志能力,玩家, 单位、当前选择、同步状态、面板尺寸和主题。 当日志 和盾有关, snapshot.instance.guild 包含其 id 财务报告和审定财务报表 name;没有盾牌的日志没有字段.

事件流和原生出

import { decodeEncounterPayloads } from "@emyrk/chronicle-panel-sdk/v1/events";
import { DamageSchema } from "@emyrk/chronicle-panel-sdk/v1/protobuf";

decodeEncounterPayloads() 解码纪事 chronicle-event-stream-v1 框架和生成的原生取出单项事件解码. 冠状原生出料来源随包在下方发布 proto/chronicle.proto。 。 。 .

自定义面板捆绑必须保持自成一体. 将此包装入 面板的输入或工人的文物,而不是为《纪事》留下 npm 导入 在运行时解决.

浮动分解

纪事拥有浮动 shell 、 拖放、 调整大小、 移动演示文稿以及 生命周期。 小组将其内容变成一个孤立的 " 阴影之旅 " :

const breakout = api.breakouts.open({
  title: "Warlock damage",
  initialPosition: { x: 200, y: 120 },
  initialSize: { width: 420, height: 300 },
  onClose: () => {
    // Drop any plugin state associated with this breakout.
  },
});

breakout.root.append(content);
// Optional; Chronicle also closes it when the panel unmounts.
breakout.close();

面板审判可同时进行8次突围. onClose 运行 在一次突围之后 不管它被《纪事》的外壳关闭过一次, 返回的手柄, closeAll(),或者面板撕毁. closeAll() 只关闭 由那个挂起的面板实例所拥有.

兼容性

• 主机 API : 1
• 明确计划: 1
• 事件设定 : chronicle-event-stream-v1

打破版本主机或流合同的更改需要新版本 进入点。 添加的原生出地仍能与电线相容.