点击此处返回 README
本文档涵盖了 HintServiceMeow 的公共 API，按功能模块组织。
命名空间：
HintServiceMeow.Core.Models.Hints
所有 Hint 类型的基类。所有 Hint（Hint、DynamicHint 等）都继承自 AbstractHint，它提供了文本内容、字体大小、同步速度和可见性等公共属性。它实现了 INotifyPropertyChanged，使属性更改自动触发显示更新。
创建任何类型的 Hint 时，无论具体的 Hint 类型如何，以下属性始终可用。
属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| Guid | Guid（只读） |
自动生成的唯一标识符 |
| Id | string |
用于查找的自定义字符串标识符。默认值："" |
| SyncSpeed | HintSyncSpeed |
更新优先级。默认值：Normal。可选值：Fastest（192）——尽快更新，可能延迟其他提示；Fast（160）——在更改时立即计划更新；Normal（128）——标准速度；Slow（96）——先等待其他提示；Slowest（64）——等待更长时间；UnSync（32）——无自动同步，当其他提示触发同步时仍会更新 |
| FontSize | int |
文本字体大小。默认值：20 |
| LineHeight | float |
行间额外垂直间距 |
| Content | AbstractHintContent |
此提示的内容提供者。默认值：StringContent("") |
| Text | string? |
获取/设置静态文本的快捷方式。设置此属性会用新的 StringContent 替换 Content |
| AutoText | AutoContent.TextUpdateHandler? |
获取/设置动态文本委托的快捷方式。设置此属性会用新的 AutoContent 替换 Content |
| Hide | bool |
提示是否隐藏。默认值：false |
使用示例：
// 属性自动同步到玩家屏幕
hint.Text = "更新后的文字";
hint.FontSize = 30;
// 无需额外的方法调用命名空间：
HintServiceMeow.Core.Models.Hints
在屏幕特定坐标处显示的固定位置提示。继承自 AbstractHint。
属性（除 AbstractHint 之外）：
| 属性 | 类型 | 描述 |
|---|---|---|
| YCoordinate | float |
垂直位置。值越大，文本在屏幕上显示越靠下。默认值：700 |
| XCoordinate | float |
水平偏移量。值越大，文本越靠右。默认值：0 |
| Alignment | HintAlignment |
文本对齐方式。可选值：Left、Right、Center。默认值：Center |
| YCoordinateAlign | HintVerticalAlign |
Y 坐标与文本的对齐方式。可选值：Top——Y 是顶部边缘；Middle——Y 是垂直中心；Bottom——Y 是底部边缘。默认值：Middle |
使用示例：
Hint hint = new Hint
{
Text = "Hello World",
FontSize = 40,
YCoordinate = 700,
Alignment = HintAlignment.Left
};
PlayerDisplay playerDisplay = PlayerDisplay.Get(player);
playerDisplay.AddHint(hint);由于 HSM 具有自动更新功能，任何属性的更改都会自动反映在玩家屏幕上，无需额外的方法调用。
hint.Text = "一些新文字";
// 无需额外的方法调用命名空间：
HintServiceMeow.Core.Models.Hints
自动定位以避免与其他提示重叠的提示。继承自 AbstractHint。
属性（除 AbstractHint 之外）：
| 属性 | 类型 | 描述 |
|---|---|---|
| TopBoundary | float |
放置的上边界。默认值：0 |
| BottomBoundary | float |
放置的下边界。默认值：1000 |
| LeftBoundary | float |
放置的左边界。默认值：-1200 |
| RightBoundary | float |
放置的右边界。默认值：1200 |
| TargetX | float |
首选水平位置。默认值：0 |
| TargetY | float |
首选垂直位置。默认值：700 |
| TopMargin | float |
排列时提示上方的额外空间。默认值：5 |
| BottomMargin | float |
排列时提示下方的额外空间。默认值：5 |
| LeftMargin | float |
排列时左侧的额外空间。默认值：100 |
| RightMargin | float |
排列时右侧的额外空间。默认值：100 |
| Priority | HintPriority |
排列优先级。优先级更高的提示先排列。可选值：Highest（192）、High（160）、Medium（128）、Low（96）、Lowest（64）。默认值：Medium |
| Strategy | DynamicHintStrategy |
无可用空间时的行为。可选值：Hide——隐藏提示；StayInPosition——保持在目标位置。默认值：Hide |
使用示例：
var dynamicHint = new DynamicHint
{
Text = "Hello Dynamic Hint"
};
PlayerDisplay playerDisplay = PlayerDisplay.Get(player);
playerDisplay.AddHint(dynamicHint);命名空间：
HintServiceMeow.Core.Utilities
管理玩家提示显示的核心类。每个玩家拥有一个 PlayerDisplay 实例。
事件：
| 事件 | 类型 | 描述 |
|---|---|---|
| UpdateAvailable | UpdateAvailableEventHandler |
每次显示准备好更新时触发 |
委托： delegate void UpdateAvailableEventHandler(UpdateAvailableEventArg ev)
属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| ReferenceHub | ReferenceHub?（只读） |
此显示所属的玩家 |
| HintParser | IHintParser |
将提示转换为富文本的解析器。可替换 |
| CompatibilityAdaptor | ICompatibilityAdaptor |
与其他插件兼容的适配器。可替换 |
静态方法：
| 方法 | 参数 | 返回值 | 描述 |
|---|---|---|---|
| Get | ReferenceHub referenceHub |
PlayerDisplay |
获取或创建玩家的 PlayerDisplay |
| Get | LabApi.Features.Wrappers.Player player |
PlayerDisplay |
获取或创建 PlayerDisplay（NW/LabApi） |
| Get | Exiled.API.Features.Player player |
PlayerDisplay |
获取或创建 PlayerDisplay（仅 EXILED） |
实例方法：
| 方法 | 参数 | 返回值 | 描述 |
|---|---|---|---|
| AddHint | AbstractHint? hint |
void |
向显示添加一个提示 |
| AddHint | IEnumerable<AbstractHint>? hints |
void |
添加多个提示 |
| AddHint | params AbstractHint[]? hints |
void |
添加多个提示（params） |
| AddHint | AbstractHint? hint, string groupName |
void |
将提示添加到特定组 |
| ShowHint | AbstractHint hint, float duration = 7f, AfterShowAction afterShow = AfterShowAction.Remove |
void |
添加提示并在 duration 秒后自动移除/隐藏。AfterShowAction 可选值：Remove——移除提示；Hide——设置 Hide = true |
| ShowHint | IEnumerable<AbstractHint> hints, float duration = 7f, AfterShowAction afterShow = AfterShowAction.Remove |
void |
显示多个提示并自动移除 |
| RemoveHint | AbstractHint? hint |
void |
移除一个提示 |
| RemoveHint | IEnumerable<AbstractHint>? hints |
void |
移除多个提示 |
| RemoveHint | params AbstractHint[]? hints |
void |
移除多个提示（params） |
| RemoveHint | AbstractHint? hint, string groupName |
void |
从特定组移除提示 |
| RemoveHint | string id |
void |
移除所有匹配给定 Id 的提示 |
| RemoveHint | Guid id |
void |
移除匹配给定 Guid 的提示 |
| ClearHint | — | void |
移除调用程序集拥有的所有提示 |
| GetHint | string? id |
AbstractHint? |
返回匹配 Id 的第一个提示 |
| GetHint | Guid guid |
AbstractHint? |
返回匹配 Guid 的第一个提示 |
| GetHints | string id |
IEnumerable<AbstractHint> |
返回所有匹配 Id 的提示 |
| GetHints | — | IEnumerable<AbstractHint> |
返回调用程序集拥有的所有提示 |
| HasHint | string id |
bool |
检查是否存在具有给定 Id 的提示 |
| HasHint | Guid guid |
bool |
检查是否存在具有给定 Guid 的提示 |
| TryGetHint | string id, out AbstractHint hint |
bool |
尝试获取匹配 Id 的第一个提示 |
| TryGetHint | Guid guid, out AbstractHint hint |
bool |
尝试获取匹配 Guid 的第一个提示 |
| TryGetHints | string? id, out IEnumerable<AbstractHint> hints |
bool |
尝试获取所有匹配 Id 的提示 |
| ForceUpdate | bool useFastUpdate = false |
void |
强制刷新显示。用于处理 HintSyncSpeed.UnSync 时使用 |
| SetMinUpdateInterval | TimeSpan interval |
void |
设置更新之间的最小间隔 |
| AddDisplayOutput | IDisplayOutput output |
void |
添加自定义显示输出 |
| RemoveDisplayOutput | IDisplayOutput output |
void |
移除显示输出 |
| RemoveDisplayOutput<T> | — | void |
移除所有类型为 T 的显示输出（其中 T : IDisplayOutput） |
使用示例：
PlayerDisplay pd = PlayerDisplay.Get(player);
// 添加提示
var hint = new Hint { Text = "你好", YCoordinate = 500 };
pd.AddHint(hint);
// 显示临时提示 5 秒
pd.ShowHint(new Hint { Text = "临时提示！" }, duration: 5f);
// 查找并修改提示
if (pd.TryGetHint("my-hint-id", out var found))
{
found.Text = "已更新";
}
// 强制更新 UnSync 提示
pd.ForceUpdate();命名空间：
HintServiceMeow.UI.Utilities
提供访问 CommonHint 的每玩家 UI 外观类。
属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| ReferenceHub | ReferenceHub（只读） |
底层玩家引用 |
| PlayerDisplay | PlayerDisplay（只读） |
玩家的 PlayerDisplay 实例 |
| CommonHint | CommonHint（只读） |
通用提示组件 |
静态方法：
| 方法 | 参数 | 返回值 | 描述 |
|---|---|---|---|
| Get | ReferenceHub referenceHub |
PlayerUI |
获取或创建玩家的 PlayerUI |
| Get | LabApi.Features.Wrappers.Player player |
PlayerUI |
获取或创建 PlayerUI（NW/LabApi） |
| Get | Exiled.API.Features.Player player |
PlayerUI |
获取或创建 PlayerUI（仅 EXILED） |
命名空间：
HintServiceMeow.UI.Utilities
为常见用例提供预配置的提示布局：物品描述、地图信息、职业信息和通用消息。
所有显示持续时间均可通过插件配置进行设置。每个重载中的 time 参数单位为秒。
方法——物品提示：
| 方法 | 参数 | 描述 |
|---|---|---|
| ShowItemHint | string itemName |
仅显示物品名称（短暂持续） |
| ShowItemHint | string itemName, float time |
仅显示物品名称，自定义持续时间 |
| ShowItemHint | string itemName, string description |
显示物品名称和一行描述 |
| ShowItemHint | string itemName, string description, float time |
显示物品名称和一行描述，自定义持续时间 |
| ShowItemHint | string itemName, string[] description |
显示物品名称和多行描述 |
| ShowItemHint | string itemName, string[] description, float time |
显示物品名称和多行描述，自定义持续时间 |
方法——地图提示：
| 方法 | 参数 | 描述 |
|---|---|---|
| ShowMapHint | string roomName |
仅显示房间名称（短暂持续） |
| ShowMapHint | string roomName, float time |
仅显示房间名称，自定义持续时间 |
| ShowMapHint | string roomName, string description |
显示房间名称和一行描述 |
| ShowMapHint | string roomName, string description, float time |
显示房间名称和一行描述，自定义持续时间 |
| ShowMapHint | string roomName, string[] description |
显示房间名称和多行描述 |
| ShowMapHint | string roomName, string[] description, float time |
显示房间名称和多行描述，自定义持续时间 |
方法——职业提示：
| 方法 | 参数 | 描述 |
|---|---|---|
| ShowRoleHint | string roleName |
仅显示职业名称（短暂持续） |
| ShowRoleHint | string roleName, float time |
仅显示职业名称，自定义持续时间 |
| ShowRoleHint | string roleName, string description |
显示职业名称和一行描述 |
| ShowRoleHint | string roleName, string description, float time |
显示职业名称和一行描述，自定义持续时间 |
| ShowRoleHint | string roleName, string[] description |
显示职业名称和多行描述 |
| ShowRoleHint | string roleName, string[] description, float time |
显示职业名称和多行描述，自定义持续时间 |
方法——其他提示：
| 方法 | 参数 | 描述 |
|---|---|---|
| ShowOtherHint | string messages |
以 DynamicHint 形式显示单条消息 |
| ShowOtherHint | string messages, float time |
显示单条消息，自定义持续时间 |
| ShowOtherHint | string[] messages |
显示多条消息（持续时间随数量变化） |
| ShowOtherHint | string[] messages, float time |
显示多条消息，自定义总持续时间 |
使用示例：
var ui = PlayerUI.Get(player);
ui.CommonHint.ShowRoleHint("SCP-173", new[] { "杀死所有人类", "使用你的技能" });
ui.CommonHint.ShowMapHint("重型收容区", "大多数 SCP 生成的地方");
ui.CommonHint.ShowItemHint("钥匙卡", "用于开门");
ui.CommonHint.ShowOtherHint("服务器正在启动！");所有扩展方法集中于此以便于参考。
命名空间：
HintServiceMeow.Core.Extension
| 方法 | 扩展类型 | 参数 | 描述 |
|---|---|---|---|
| HideAfter | AbstractHint |
float delay |
在 delay 秒后将 Hide 设为 true。重置任何现有的隐藏计时器 |
hint.HideAfter(5f); // 5 秒后隐藏提示命名空间：
HintServiceMeow.Core.Extension
| 方法 | 扩展类型 | 参数 | 描述 |
|---|---|---|---|
| RemoveAfter | PlayerDisplay |
AbstractHint hint, float delay |
在 delay 秒后从显示中移除提示。重置任何现有的移除计时器 |
playerDisplay.RemoveAfter(hint, 10f); // 10 秒后移除提示命名空间：
HintServiceMeow.Core.Extension/HintServiceMeow.UI.Extension
LabApi.Features.Wrappers.Player 的扩展方法。
| 方法 | 命名空间 | 返回值 | 描述 |
|---|---|---|---|
| GetPlayerDisplay | Core | PlayerDisplay |
获取玩家的 PlayerDisplay |
| AddHint | Core | void |
向玩家显示添加提示 |
| RemoveHint | Core | void |
从玩家显示移除提示 |
| GetPlayerUi | UI | PlayerUI |
获取玩家的 PlayerUI 实例 |
// 使用 NW player 扩展（LabApi）
LabApi.Features.Wrappers.Player player = ...;
// 获取 PlayerDisplay 并直接在玩家对象上添加提示
var hint = new Hint { Text = "来自 NW 扩展的问候！", YCoordinate = 500 };
player.AddHint(hint);
// 之后移除
player.RemoveHint(hint);
// 访问 PlayerDisplay 进行更高级的操作
PlayerDisplay pd = player.GetPlayerDisplay();
pd.ShowHint(new Hint { Text = "临时提示！" }, duration: 3f);
// 访问 PlayerUI 和 CommonHint
PlayerUI ui = player.GetPlayerUi();
ui.CommonHint.ShowRoleHint("SCP-096", new[] { "坐下哭泣", "追逐目标" });命名空间：
HintServiceMeow.Core.Extension/HintServiceMeow.UI.Extension
Exiled.API.Features.Player 的扩展方法。仅在 EXILED 构建中可用。
| 方法 | 命名空间 | 返回值 | 描述 |
|---|---|---|---|
| GetPlayerDisplay | Core | PlayerDisplay |
获取玩家的 PlayerDisplay |
| AddHint | Core | void |
向玩家显示添加提示 |
| RemoveHint | Core | void |
从玩家显示移除提示 |
| GetPlayerUi | UI | PlayerUI |
获取玩家的 PlayerUI 实例 |
// 使用 EXILED player 扩展
Exiled.API.Features.Player player = ...;
// 获取 PlayerDisplay 并直接在玩家对象上添加提示
var hint = new Hint { Text = "来自 EXILED 扩展的问候！", YCoordinate = 500 };
player.AddHint(hint);
// 之后移除
player.RemoveHint(hint);
// 访问 PlayerDisplay 进行更高级的操作
PlayerDisplay pd = player.GetPlayerDisplay();
pd.ShowHint(new Hint { Text = "临时提示！" }, duration: 3f);
// 访问 PlayerUI 和 CommonHint
PlayerUI ui = player.GetPlayerUi();
ui.CommonHint.ShowItemHint("O5 钥匙卡", "可进入所有区域");这些类在内部被提示用于管理其文本内容。在大多数情况下，您不需要直接与它们交互——直接使用 AbstractHint 上的 Text 或 AutoText 属性即可。
命名空间：
HintServiceMeow.Core.Models.HintContent
Hint 内容提供者的基类。
事件：
| 事件 | 类型 | 描述 |
|---|---|---|
| ContentUpdated | UpdateHandler |
内容更改时触发 |
方法：
| 方法 | 参数 | 返回值 | 描述 |
|---|---|---|---|
| GetText | — | string? |
返回当前文本内容 |
命名空间：
HintServiceMeow.Core.Models.HintContent
保存静态文本的内容提供者。继承自 AbstractHintContent。
构造函数： StringContent(string? content)
属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| Text | string? |
静态文本。更改时触发 ContentUpdated |
命名空间：
HintServiceMeow.Core.Models.HintContent
定期调用委托以生成动态文本的内容提供者。继承自 AbstractHintContent。
委托： delegate string TextUpdateHandler(AutoContentUpdateArg ev)
构造函数： AutoContent(TextUpdateHandler? autoText, float defaultUpdateInterval = -1)
如果 defaultUpdateInterval 为负数，则默认为 0.1 秒。
属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| AutoText | TextUpdateHandler? |
调用以生成文本的委托。重置此项也会重置下次更新时间 |
使用示例：
hint.AutoText = (ev) =>
{
ev.NextUpdateDelay = TimeSpan.FromSeconds(1); // 每 1 秒更新一次
return $"时间：{DateTime.Now:HH:mm:ss}";
};点击此处返回 README