228 lines
5.4 KiB
Markdown
228 lines
5.4 KiB
Markdown
---
|
||
sidebarDepth: 1
|
||
---
|
||
# 官方聊天扩展
|
||
|
||
## AddCommonPhrases
|
||
|
||
<span style="display:inline;color:#ff5555">服务端</span>
|
||
|
||
method in mod.server.component.chatExtensionCompServer.ChatExtensionComponentServer
|
||
|
||
- 描述
|
||
|
||
为官方聊天扩展功能添加常用短语。单人模式下单个模组最多添加12条，联机大厅和网络服无条数限制。
|
||
|
||
- 参数
|
||
|
||
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- | :--- |
|
||
| id | int | 聊天短语的唯一id，若使用了相同的id会覆盖原有文本内容 |
|
||
| content | str | 聊天短语的文本内容，文本字数限制20，超出时添加失败 |
|
||
|
||
- 返回值
|
||
|
||
| <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- |
|
||
| bool | 添加结果 |
|
||
|
||
- 示例
|
||
|
||
```python
|
||
import mod.server.extraServerApi as serverApi
|
||
comp = serverApi.GetEngineCompFactory().CreateChatExtension(playerId)
|
||
comp.AddCommonPhrases(1001, "大家一起合作吧")
|
||
```
|
||
|
||
|
||
|
||
## Disable
|
||
|
||
<span style="display:inline;color:#ff5555">服务端</span>
|
||
|
||
method in mod.server.component.chatExtensionCompServer.ChatExtensionComponentServer
|
||
|
||
- 描述
|
||
|
||
关闭官方聊天扩展功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅和网络服中生效。
|
||
|
||
- 参数
|
||
|
||
无
|
||
|
||
- 返回值
|
||
|
||
| <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- |
|
||
| bool | 关闭结果 |
|
||
|
||
- 示例
|
||
|
||
```python
|
||
import mod.server.extraServerApi as serverApi
|
||
comp = serverApi.GetEngineCompFactory().CreateChatExtension(playerId)
|
||
comp.Disable()
|
||
```
|
||
|
||
|
||
|
||
## Enable
|
||
|
||
<span style="display:inline;color:#ff5555">服务端</span>
|
||
|
||
method in mod.server.component.chatExtensionCompServer.ChatExtensionComponentServer
|
||
|
||
- 描述
|
||
|
||
启用官方聊天扩展功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅和网络服中生效。
|
||
|
||
- 参数
|
||
|
||
无
|
||
|
||
- 返回值
|
||
|
||
| <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- |
|
||
| bool | 启用结果 |
|
||
|
||
- 示例
|
||
|
||
```python
|
||
import mod.server.extraServerApi as serverApi
|
||
comp = serverApi.GetEngineCompFactory().CreateChatExtension(playerId)
|
||
comp.Enable()
|
||
```
|
||
|
||
|
||
|
||
## RegisterChatPrefix
|
||
|
||
<span style="display:inline;color:#ff5555">服务端</span>
|
||
|
||
method in mod.server.component.chatExtensionCompServer.ChatExtensionComponentServer
|
||
|
||
- 描述
|
||
|
||
为游戏内指定玩家注册聊天前缀。仅在主界面消息框和聊天界面游戏频道生效。建议在AddServerPlayerEvent事件中调用，为新玩家添加前缀。
|
||
|
||
- 参数
|
||
|
||
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- | :--- |
|
||
| prefix | str | 聊天前缀文本。字数限制10，超出部分舍弃尾部字符。若在前缀文本中额外使用颜色代码会导致prefixColor参数失效，颜色代码同样占用字数限制。 |
|
||
| prefixColor | str | 聊天前缀文本颜色代码。可以使用GenerateColor接口传入参数 |
|
||
|
||
- 返回值
|
||
|
||
| <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- |
|
||
| bool | 注册结果 |
|
||
|
||
- 示例
|
||
|
||
```python
|
||
import mod.server.extraServerApi as serverApi
|
||
comp = serverApi.GetEngineCompFactory().CreateChatExtension(playerId)
|
||
comp.RegisterChatPrefix("魔王", serverApi.GenerateColor('RED'))
|
||
```
|
||
|
||
|
||
|
||
## RemoveCommonPhrases
|
||
|
||
<span style="display:inline;color:#ff5555">服务端</span>
|
||
|
||
method in mod.server.component.chatExtensionCompServer.ChatExtensionComponentServer
|
||
|
||
- 描述
|
||
|
||
为官方聊天扩展功能移除常用短语。
|
||
|
||
- 参数
|
||
|
||
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- | :--- |
|
||
| id | int | 聊天短语的唯一id |
|
||
|
||
- 返回值
|
||
|
||
| <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- |
|
||
| bool | 移除结果 |
|
||
|
||
- 示例
|
||
|
||
```python
|
||
import mod.server.extraServerApi as serverApi
|
||
comp = serverApi.GetEngineCompFactory().CreateChatExtension(playerId)
|
||
comp.RemoveCommonPhrases(1001)
|
||
```
|
||
|
||
|
||
|
||
## SetShowOfficialPhrases
|
||
|
||
<span style="display:inline;color:#ff5555">服务端</span>
|
||
|
||
method in mod.server.component.chatExtensionCompServer.ChatExtensionComponentServer
|
||
|
||
- 描述
|
||
|
||
设置是否显示官方的常用聊天短语。仅在联机大厅和网络服中生效。
|
||
|
||
- 参数
|
||
|
||
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- | :--- |
|
||
| show | bool | 是否显示 |
|
||
|
||
- 返回值
|
||
|
||
| <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- |
|
||
| bool | 设置结果 |
|
||
|
||
- 示例
|
||
|
||
```python
|
||
import mod.server.extraServerApi as serverApi
|
||
comp = serverApi.GetEngineCompFactory().CreateChatExtension(playerId)
|
||
comp.SetShowOfficialPhrases(False) # 不显示
|
||
```
|
||
|
||
|
||
|
||
## SetShowSocialNearbyInfo
|
||
|
||
<span style="display:inline;color:#ff5555">服务端</span>
|
||
|
||
method in mod.server.component.chatExtensionCompServer.ChatExtensionComponentServer
|
||
|
||
- 描述
|
||
|
||
设置是否显示官方聊天社交界面中同一游戏玩家是否在附近信息。
|
||
|
||
- 参数
|
||
|
||
| 参数名 | <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- | :--- |
|
||
| show | bool | 是否显示 |
|
||
|
||
- 返回值
|
||
|
||
| <div style="width: 4em">数据类型</div> | 说明 |
|
||
| :--- | :--- |
|
||
| bool | 设置结果 |
|
||
|
||
- 示例
|
||
|
||
```python
|
||
import mod.server.extraServerApi as serverApi
|
||
comp = serverApi.GetEngineCompFactory().CreateChatExtension(playerId)
|
||
comp.SetShowSocialNearbyInfo(False) # 不显示
|
||
```
|
||
|
||
|
||
|