Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
MeowServer committed Jun 12, 2024
2 parents 1ccf5b8 + a8c9d2c commit 3890549
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ To install this plugin, please go to the release page and download the newest Hi
- This plugin is designed for my own server. It should be compatible with any Exiled servers, but if not, please contact me.

## To Developers
Please use [RueI](https://github.com/Ruemena/RueI) instead. RueI is a much more mature framework.
If you insist on using this plugin instead of RueI, here's an easy documentary about this plugin:
Here's an easy documentary of this plugin:
1. First, there are 2 ways to show a hint to a player
- Create an instance of hint and add them to the PlayerDisplay instance corresponding to the player.
- Get PlayerUI corresponding to the player, and use the "ShowCommonHint" methods of that PlayerUI.
Expand Down
8 changes: 3 additions & 5 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ HintServiceMeow 是一款基于Exiled框架的插件,用于向玩家同时展
- 这个插件是为Meow服务器所设计的,和其他Exiled服务器兼容,但如果不兼容,请联系我。

### 致开发者
请使用 [RueI](https://github.com/Ruemena/RueI) 其相较于本插件更加的成熟稳定

如果你坚持使用本插件而非RueI, 这是一个简单的指导:
这里是一个简单的指导:
1. 首先,有两种方式向一个玩家展示一条Hint
- 创建一个hint类型的实例,并将其加入到和玩家对应的PlayerDisplay类中
- 直接获取玩家对应的PlayerUI,并使用“常用Hint”方法
- 直接获取玩家对应的PlayerUI,并使用“通用Hint”方法
2. 通过创建Hint实例来展示Hint
```csharp
var hint = new Hint(100, HintAlignment.Left , "HelloWorld!") ;
Expand All @@ -41,7 +39,7 @@ playerUI.ShowItemHint("CustomItem", "This is a custom item");
PlayerUI是PlayerDisplay的拓展,可以更方便的向玩家展示Hint。其包含通用Hint,玩家UI,和屏幕效果(还未实装)。通用Hint代表了插件经常用到的几种提示,这包含地图提示,角色提示,物品提示,和其他提示。以上是一个使用通用Hint的例子
### Bugs
这些是一些尚未解决的插件Bug:
- 当玩家的子弹达到上限时,其会受到一条Hint通知其携带的子弹数量以达到上限。然而,这个Hint会打断正在展示的Hint。目前没有找到解决办法,只能每过5秒强行刷新一次Hint。在刷新之前向玩家展示的Hint会全部失效。
- 当玩家的子弹达到上限时,其会受到一条Hint通知其携带的子弹数量已达到上限。然而,这个Hint会打断正在展示的Hint。目前没有找到解决办法,只能每过每过一段时间强行刷新一次Hint。在刷新之前向玩家展示的Hint会全部失效。
- 当大量的Hint在相近的高度时,其显示位置可能发生偏差。
### 更新计划
下一次更新中会加入PlayerUI的配置文件,让服务器管理者可以自定义PlayerUI。(正在V3.2中实现)

0 comments on commit 3890549

Please sign in to comment.