@occultus/text-api

Star Tenon Text API

这是一个用于解析和转换游戏内文本的 API，提供了灵活的文本处理功能。

功能特性

• 支持动态文本解析；
• 自动处理字符串和 RawMessage 转换；
• 提供便捷的文本转换方法。

TextProvider 类型

type TextProvider =
  | string
  | RawMessage
  | ((player: Player) => string | RawMessage);

这是一种动态的文本类型，支持将字符串、RawMessage 或函数作为文本来源。

可以使用parseText函数来对其进行解析。

API 文档

parseText

解析 TextProvider 提供的文本

function parseText(text: TextProvider, player: Player): string | RawMessage;

参数:

• text: 要解析的文本，可以是字符串、函数或 RawMessage
• player: 看到文本的玩家对象

返回值:

• 解析后的字符串或 RawMessage

parseToRaw

将 TextProvider 解析为 RawMessage

function parseToRaw(text: TextProvider, player: Player): RawMessage;

参数:

• text: 要解析的文本
• player: 看到文本的玩家对象

返回值:

• 解析后的 RawMessage

simpleToRaw

快速将无法确定类型的文本解析为 RawMessage

function simpleToRaw(str: RawMessage | string): RawMessage;

参数:

• str: 要转换的文本，可以是字符串或 RawMessage

返回值:

• 转换后的 RawMessage

使用示例

import { parseText, parseToRaw, simpleToRaw } from "./TextProvider";

// 基本字符串解析
const text1 = "Hello, world!";
const raw1 = simpleToRaw(text1);

// 动态文本解析
const dynamicText = (player: Player) => `Hello, ${player.name}!`;
const raw2 = parseToRaw(dynamicText, player);

// 混合类型解析
const mixedText = (player: Player) => ({
  text: `Hello, ${player.name}!`,
  color: "gold"
});
const result = parseText(mixedText, player);

支持版本

本 API 支持任意可以运行 Script API v2.0.0+ 的游戏版本，包括：

• 1.21.90；
• 1.21.100；
• 1.21.110；
• 以及更多……

注意：本包理论上可以在部分更旧的版本上运作，但未经过严格的测试。

协议

本项目使用 MIT License 授权：

The MIT License (MIT)

Copyright © 2025 CTN Studios

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

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.