meta data for this page
📚 差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录前一修订版后一修订版 | 前一修订版 | ||
scripting:world:player [2024/05/05 11:11] – bibiboxs | scripting:world:player [2025/07/26 22:49] (当前版本) – bibiboxs | ||
---|---|---|---|
行 13: | 行 13: | ||
> 当新玩家加入到主机房间时调用。 | > 当新玩家加入到主机房间时调用。 | ||
+ | > | ||
+ | > ==注意:此时玩家只是连接成功,并非加载完成,完整加载使用`OnPlayerComplete`。== | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerComplete( player ) | ||
+ | |||
+ | > 当玩家完全加载完成时调用。 | ||
+ | > | ||
+ | > ==此事件是获取玩家完全载入状态的正确方法。== | ||
行 30: | 行 40: | ||
> 此事件拥有返回值机制,如果返回为`false`则不使用内置的聊天输出机制(将不会输出任何消息),默认返回`true`。 | > 此事件拥有返回值机制,如果返回为`false`则不使用内置的聊天输出机制(将不会输出任何消息),默认返回`true`。 | ||
> | > | ||
- | > *如果有自定义输出聊天样式的需求,可以通过`return 0`然后使用`Message(" | + | > *如果有自定义输出聊天样式的需求,可以通过`return 0`然后使用`Message(" |
> | > | ||
- | > **注意:沙盘引擎默认聊天消息经过了`Native.FormatRichText()`格式化,这将使文本支持[URL\@AT\Emoji]等高亮显示,如果有自定义Chat需求并希望支持这些功能,可以使用此API格式化一次。** | + | > **注意:沙盘引擎默认聊天消息经过了`Native.FormatRichText()`格式化,这将使文本支持[URL\@AT\Emoji]等高亮显示,如果有自定义Chat需求并希望支持这些功能,可以在手动发送Message前使用此API格式化一次。** |
```javascript | ```javascript | ||
行 44: | 行 54: | ||
``` | ``` | ||
+ | |||
+ | |||
+ | ### OnPlayerNetworkCMD( cmd, arg0, arg1, arg2 ) | ||
+ | |||
+ | > 当接收到来自玩家客户端发送的**CMD消息**时调用,**这是客户端与服务端传输自定义信息的方式之一**。 | ||
+ | > | ||
+ | > **对于一些特殊情况,可以利用`json to string`进行更详细的内容传输。** | ||
+ | |||
+ | [note2] | ||
+ | |||
+ | 注意:`CMD\RPC`传输支持几个基础类型(`int | float | string | bool`)。 | ||
+ | |||
+ | [/note] | ||
行 83: | 行 106: | ||
```javascript | ```javascript | ||
function OnPlayerVoiceStateChange( player: Player, state: bool ) | function OnPlayerVoiceStateChange( player: Player, state: bool ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerFocusEntityChange( player, entity ) | ||
+ | |||
+ | > 当玩家焦点对象发生改变时调用。 | ||
+ | |||
+ | ```javascript | ||
+ | function OnPlayerFocusEntityChange( player: Player, entity: Entity ) | ||
``` | ``` | ||
行 101: | 行 134: | ||
### OnPlayerKeyDown( player, keyTag ) | ### OnPlayerKeyDown( player, keyTag ) | ||
- | > 当玩家按下**服务器绑定按键**时调用,只有服务器绑定的按键才会触发。 | + | > 当玩家按下**服务器监听按键**时调用,只有服务器监听的按键(`RegisterKeyListener`)才会触发。 |
行 107: | 行 140: | ||
### OnPlayerKeyUp( player, keyTag ) | ### OnPlayerKeyUp( player, keyTag ) | ||
- | > 当玩家抬起**服务器绑定按键**时调用,只有服务器绑定的按键才会触发。 | + | > 当玩家抬起**服务器监听按键**时调用,只有服务器监听的按键(`RegisterKeyListener`)才会触发。 |
- | ### OnPlayerNativeKeyDown( player, | + | ### OnPlayerWorldChange( player, |
+ | |||
+ | > 当玩家世界ID发生改变时调用。 | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerColorChange( player, color ) | ||
+ | |||
+ | > 当玩家颜色发生改变时调用。 | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerNameChange( player, name ) | ||
+ | |||
+ | > 当玩家名称发生改变时调用。 | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerBackpackPropOperation( player, slot, isMain, isShift ) | ||
+ | |||
+ | > 当玩家背包请求操作物品时调用。 | ||
+ | > | ||
+ | > 此方法可配合`player.GetBackpackTempProp()`使用。 | ||
+ | |||
+ | - `isMain`:是否为左键(主要)点击(否则为右键) | ||
+ | - `isShift`:是否按住Shift键 | ||
+ | - `return`:默认返回`true`,决定是否允许后续操作 | ||
- | > 当玩家按下**服务器监听的原生公开按键**时调用,只有服务器监听的原生按键才会触发。 | ||
+ | ### OnPlayerBackpackPropDiscard( player, prop, isDelete ) | ||
- | ### OnPlayerNativeKeyUp( player, keyTag ) | + | > 当玩家背包请求扔掉物品时调用。 |
- | > 当玩家抬起**服务器监听的原生公开按键**时调用,只有服务器监听的原生按键才会触发。 | + | - `isDelete`:是否为请求删除物品(否则视为丢弃) |
+ | - `return`:默认返回`true`,决定是否允许后续操作 | ||
行 169: | 行 229: | ||
```javascript | ```javascript | ||
player.Address: | player.Address: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.Data | ||
+ | |||
+ | > 内置的自定义类型属性(建议使用基础类型),可供开发者自行使用,需要自行做好类型Type和生命周期处理。 | ||
+ | |||
+ | ```javascript | ||
+ | player.Data = null; //any | ||
``` | ``` | ||
行 197: | 行 267: | ||
| 索引 | 版本 | | 索引 | 版本 | ||
| ---- | -------------------- | | | ---- | -------------------- | | ||
- | | 0 | 免费版(Demo\Steam) | | + | | 0 | 标准版(Demo\Steam) | |
- | | 1 | 标准版(Steam) | + | | 1 | 白金版(Steam+DLC) | |
行 214: | 行 284: | ||
| ---- | ------------------------------------- | | | ---- | ------------------------------------- | | ||
| 0 | 本地用户,非Steam用户(可能非安全的) | | | 0 | 本地用户,非Steam用户(可能非安全的) | | ||
- | | 1 | Steam用户(包含免费版+标准版) | + | | 1 | Steam用户(标准版\白金版) |
行 317: | 行 387: | ||
```javascript | ```javascript | ||
player.Character: | player.Character: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.IsAdmin | ||
+ | |||
+ | > 设置玩家**是否为管理员**,管理员可通过[TAB]菜单进行基础的玩家管理。 | ||
+ | > | ||
+ | > 通常情况下,此属性是一个验证管理员权限的**预制抽象属性**,开发者可考虑自行编写更高级的管理员系统。 | ||
+ | |||
+ | ```javascript | ||
+ | player.IsAdmin = false; | ||
``` | ``` | ||
行 343: | 行 425: | ||
### player.FocusPos | ### player.FocusPos | ||
- | > 获取玩家控制焦点坐标,如果玩家正在控制一个角色,则两者坐标相同(同步于此属性)。 | + | > 获取玩家视角焦点坐标(屏幕中心、准星& |
> | > | ||
- | > 在玩家不同视角模式(`Client.Camera.Mode`)下(鸟瞰、第三人称),此部分的坐标获取方式会发生变化。 | + | > 在玩家不同视角模式(`Client.Camera.Mode`)下(鸟瞰、第一人称、第三人称),坐标获取方式会发生变化。 |
> | > | ||
- | > 主要表现于:【鸟瞰】基于陆地坐标;【第三人称】屏幕准星焦点 | + | > 主要表现于:[鸟瞰]鼠标坐标、[第三人称]屏幕准星坐标 |
```javascript | ```javascript | ||
行 355: | 行 437: | ||
- | ### player.Angle | + | ### player.FocusEntity |
- | > 获取玩家**屏幕方向**角度。 | + | > 获取玩家**视角焦点实体**,如果不存在则返回`null`。 |
+ | |||
+ | ```javascript | ||
+ | player.FocusEntity: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.FocusEntityDistance | ||
+ | |||
+ | > 获取玩家**视角焦点实体检测距离**,此数值直接影响`FocusEntity`的检测结果,默认距离为`3.0`(`0.0~512.0`)。 | ||
+ | > | ||
+ | > **注意:对于远距离视角、鸟瞰视角等情况,应该在合理范围内调高此数值,否则可能距离过短导致无法正确检测。** | ||
+ | |||
+ | ```javascript | ||
+ | player.FocusEntityDistance: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.FocusVAngle | ||
+ | |||
+ | > 设置& | ||
+ | |||
+ | ```javascript | ||
+ | player.FocusVAngle: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.FocusHAngle | ||
+ | |||
+ | > 设置& | ||
+ | |||
+ | ```javascript | ||
+ | player.FocusHAngle: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.FocusEulerAngle | ||
+ | |||
+ | > 设置& | ||
+ | > | ||
+ | > 在玩家不同视角模式(`Client.Camera.Mode`)下,坐标处理方式会发生变化。 | ||
+ | |||
+ | [note2] | ||
+ | 注意:多数情况下,应该使用`Client\Camera`实现视角相关逻辑。 | ||
+ | [/note] | ||
+ | |||
+ | ```javascript | ||
+ | player.FocusAngle: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.FocusAngleForward | ||
+ | |||
+ | > 获取玩家**控制焦点**前方向量。 | ||
+ | > | ||
+ | > 在玩家不同视角模式(`Client.Camera.Mode`)下,坐标处理方式会发生变化。 | ||
```javascript | ```javascript | ||
- | player.Angle: float | + | player.FocusAngleForward: Vector2 |
``` | ``` | ||
行 393: | 行 535: | ||
```javascript | ```javascript | ||
player.IsTyping: | player.IsTyping: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.IsComplete | ||
+ | |||
+ | > 获取玩家是否完全加载完毕。 | ||
+ | |||
+ | ```javascript | ||
+ | player.IsComplete: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.IsObserver | ||
+ | |||
+ | > 获取玩家是否当前为相机观察模式(`Client.Camera.IsObserver`)。 | ||
+ | |||
+ | ```javascript | ||
+ | player.IsObserver: | ||
``` | ``` | ||
行 422: | 行 584: | ||
> 设置玩家的相机自由模式开关(`Client.Camera.FreeMode`)。 | > 设置玩家的相机自由模式开关(`Client.Camera.FreeMode`)。 | ||
+ | |||
+ | [note2] | ||
+ | 注意:此模式不会修改鼠标可见状态,因此通常应该手动关闭鼠标可见(Client),已达到随鼠标自由旋转。 | ||
+ | [/note] | ||
```javascript | ```javascript | ||
行 475: | 行 641: | ||
### Player.Search() | ### Player.Search() | ||
- | > 寻找一个玩家实例(通过模糊查找,通常根据玩家名称,不区分大小写),不存在则返回`null`。 | + | > 寻找一个玩家实例(通过模糊查找,通常根据玩家名称\ID,不区分大小写),不存在则返回`null`。 |
```javascript | ```javascript | ||
行 486: | 行 652: | ||
Player.Search(" | Player.Search(" | ||
Player.Search(" | Player.Search(" | ||
+ | Player.Search(" | ||
``` | ``` | ||
行 589: | 行 756: | ||
### player.Kick() | ### player.Kick() | ||
- | > 从服务器踢出指定玩家。 | + | > 从服务器踢出玩家。 |
```javascript | ```javascript | ||
行 599: | 行 766: | ||
### player.Ban() | ### player.Ban() | ||
- | > 从服务器封禁指定玩家(仅在当前服务器运行时生效,重启服务器后将清空封禁列表)。 | + | > 从服务器封禁玩家(仅在服务器运行时生效,重启服务器将清空封禁列表)。 |
> | > | ||
> 如果希望实现持久化的封禁列表,请考虑自行实现维护一个`txt|json`文件表,在每次服务器建立后读取文件+遍历执行`Player.BanUUID()`。 | > 如果希望实现持久化的封禁列表,请考虑自行实现维护一个`txt|json`文件表,在每次服务器建立后读取文件+遍历执行`Player.BanUUID()`。 | ||
行 606: | 行 773: | ||
function player.Ban( reason: string = " | function player.Ban( reason: string = " | ||
``` | ``` | ||
- | |||
- | |||
- | |||
- | ### player.CreateNativeMenu() | ||
- | |||
- | > 为玩家建立一个`NativeMenu`菜单([NativeMenu菜单](scripting/ | ||
- | |||
- | ```javascript | ||
- | let view = { | ||
- | Cover: 5, | ||
- | Tag: " | ||
- | Title: " | ||
- | Info: " | ||
- | Width: 500, | ||
- | Align: 1, | ||
- | Layout: 1, | ||
- | Items: [ | ||
- | { | ||
- | Text: " | ||
- | OnClick: () => { | ||
- | DLog(" | ||
- | } | ||
- | },{ | ||
- | Input: " | ||
- | Restrict: " | ||
- | OnFocus: (text) => { | ||
- | DLog(" | ||
- | } | ||
- | },{ | ||
- | Text: " | ||
- | OnClick: () => { | ||
- | Vehicle.Create(10, | ||
- | player.DestroyNativeMenu(); | ||
- | } | ||
- | } | ||
- | ] | ||
- | }; | ||
- | |||
- | player.CreateNativeMenu(view); | ||
- | ``` | ||
- | |||
- | |||
- | |||
- | ### player.DestroyNativeMenu() | ||
- | |||
- | > 为玩家关闭`NativeMenu`菜单,用法与[客户端NativeMenu](scripting/ | ||
- | |||
- | |||
- | |||
- | ### player.SetNativeMenuText() | ||
- | |||
- | > 为玩家关闭`NativeMenu`菜单,用法与[客户端NativeMenu](scripting/ | ||
行 691: | 行 806: | ||
- | ### player.StoryDialog() | + | ### player.NetworkRPC() |
- | > 为玩家发送一条**故事对话框**消息,并加入到队列中,等待上次对话框结束后陆续执行。 | + | > 为玩家发送一条RPC指令。 |
> | > | ||
- | > **解释:此方法执行后可能不会立即显示,默认会加入到队列中,按加入顺序依次执行历史对话框。** | + | > 目标玩家客户端脚本通过`OnServerNetworkRPC()`接收数据。 |
+ | > | ||
+ | > **注意:`CMD\RPC`方法仅支持基础类型,并且会自动类型转换。** | ||
```javascript | ```javascript | ||
- | function | + | function |
``` | ``` | ||
- | - **title:**标题、故事对话人昵称 | ||
- | - **text:**主要文本内容(可用`html`语法,以及`\n`换行) | ||
- | - **avatar:**故事对话人形象图片ID(基于Texture文件机制),默认为`-1` | ||
- | - **sound:**故事对话时音频ID(例如配音等,基于Sound文件机制),默认为`-1`,仅在当前对话框生命周期有效,对话结束(或切换对话框)后将自动停止播放 | ||
- | - **buttons:**附加按钮(最多支持3个),以数组的形式传递数据(见下方示例) | ||
- | - **onComplete:**对话结束时触发事件 | ||
- | ```javascript | ||
- | player.StoryDialog(" | ||
- | { | ||
- | Button: " | ||
- | Action: () => { | ||
- | DLog(" | ||
- | } | ||
- | },{ | ||
- | Button: " | ||
- | Action: () => { | ||
- | DLog(" | ||
- | } | ||
- | } | ||
- | ], () => { | ||
- | DLog(" | ||
- | }); //1 | ||
- | player.StoryDialog(" | ||
- | player.StoryDialog(" | ||
- | ``` | ||
+ | ### player.SendData() | ||
- | + | > 为玩家发送一条**服务端> | |
- | ### player.NextStoryDialog() | + | > |
- | + | > 目标玩家客户端脚本通过`OnServerStreamData()`接收数据。 | |
- | > 为玩家切换下一个**故事对话框(如有队列)**,相当于自动为玩家执行了跳过方法,并且会忽略Buttons焦点(无论是否设置Buttons,都会切换到下一个队列)。 | + | > |
+ | > **注意:这里不应该放置特别大的数据内容(4096),否则可能造成网络阻塞。** | ||
```javascript | ```javascript | ||
- | function player.NextStoryDialog() | + | function player.SendData( number: float, data: string = "" |
``` | ``` | ||
- | ### player.ClearStoryDialog() | + | ### player.ClientExec() |
- | > 为玩家清空**故事对话框队列**,并结束全部故事对话框(会触发队列最后一个`OnComplete`)。 | + | > 为玩家发送一条**客户端脚本代码**,目标玩家**客户端**将执行对应的脚本代码。 |
- | + | ||
- | ```javascript | + | |
- | function player.ClearStoryDialog() | + | |
- | ``` | + | |
- | + | ||
- | + | ||
- | + | ||
- | ### player.SendData() | + | |
- | + | ||
- | > 为玩家发送一条**服务端> | + | |
> | > | ||
- | > 目标玩家客户端脚本通过`OnServerStreamData()`接收数据。 | + | > **注意:这里不应该放置特别大的数据内容(2048),否则可能造成网络阻塞。** |
- | > | + | |
- | > **注意:这里不应该放置特别大的数据内容,否则可能造成网络阻塞。** | + | |
```javascript | ```javascript | ||
- | function player.SendData( number: float, data: string | + | function player.ClientExec( code: string ) |
``` | ``` | ||
行 884: | 行 966: | ||
- | ### player.BindKeyPresser() | + | ### player.RunTask() |
- | > 为玩家绑定**按键快捷对象**的UI布局方式(2D屏幕、3D坐标、实体对象跟随),具体取决于参数类型。 | + | > 为玩家执行一次**倒计时任务**(例如拆除炸弹+UI进度条),每个玩家同一时间只能执行一个任务 |
- | > | + | |
- | > ==注意:每次建立的**按键快捷对象**全部移出后,再次建立时,UI布局方式将自动切换至`Null(2D屏幕偏右)`。== | + | |
```javascript | ```javascript | ||
- | function player.BindKeyPresser( target: any ) | + | function player.RunTask( time: float, title: string, onComplete: Action, theme: int = 0 ) |
- | /* | + | |
- | target可选类型:null\Vector\Entity(Vector\Entity类型将作为3D坐标展示,Entity会有自动跟随) | + | |
- | */ | + | |
``` | ``` | ||
- | + | - **`theme`:**范围0~4,表示不同的颜色 | |
- | + | ||
- | ### player.AddKeyPresser() | + | |
- | + | ||
- | > 为玩家建立一个**按键快捷对象**,默认将加入到玩家**屏幕偏右**位置,如果你希望目标UI作为3D空间、跟随实体效果,使用`BindKeyPresser`提前绑定即可。 | + | |
- | > | + | |
- | > 这将在目标玩家的屏幕中显示`[按键] XXXX`的效果(例如`[F]进入此载具`,并为其绑定进入载具的事件)。 | + | |
- | > | + | |
- | > 同时,此功能支持同时**绑定至多6个按键对象**(同列表下,并非不同位置),只需要为其填写不同的index即可。 | + | |
- | > | + | |
- | > **Index目前只是标签占位,排序仍然根据代码添加顺序。** | + | |
```javascript | ```javascript | ||
- | function | + | player.RunTask(5, " |
- | /* | + | //C4 Setup |
- | index:指引索引(如索引已存在指引,将会替换修改,一个index只能存在并表示一个指引实例),相当于一个标签作用 | + | }); |
- | keyCode:绑定按键,最好不要和其他按键冲突,除非知道在做什么 | + | |
- | text:按键后面的文本内容 | + | |
- | onPress:当玩家按下后执行的事件 | + | |
- | */ | + | |
- | + | ||
- | // | + | |
- | // | + | |
``` | ``` | ||
- | ```javascript | ||
- | // | ||
- | player.AddKeyPresser(0, | ||
- | player.AddKeyPresser(3, | ||
- | // | ||
- | 【F】进入当前载具 | ||
- | 【H】修复当前载具 | ||
- | ``` | ||
+ | ### player.StopTask() | ||
- | + | > 停止玩家**倒计时任务**。 | |
- | ### player.RemoveKeyPresser() | + | |
- | + | ||
- | > 为玩家移除一个**按键快捷对象**。 | + | |
- | > | + | |
- | > ==注意:每次建立的**按键快捷对象**全部移出后,再次建立时,UI布局方式将自动切换至`Null(2D屏幕右下)`。== | + | |
```javascript | ```javascript | ||
- | function player.RemoveKeyPresser( index: int ) | + | function player.StopTask() |
``` | ``` | ||
- | ### player.ExistKeyPresser() | + | ### player.AddGuider() |
- | > 获取玩家**指定索引**的**按键快捷对象**是否存在。 | + | > 为玩家建立一个指引目标(屏幕边缘箭头),允许附加指引文字(支持宏文本)。 |
- | + | ||
- | ```javascript | + | |
- | function player.ExistKeyPresser( index: int ): bool | + | |
- | ``` | + | |
- | + | ||
- | + | ||
- | + | ||
- | ### player.ClearKeyPressers() | + | |
- | + | ||
- | > 移除玩家所有**按键快捷对象**。 | + | |
> | > | ||
- | > ==注意:每次建立的**按键快捷对象**全部移出后,再次建立时,UI布局方式将自动切换至`Null(2D屏幕右下)`。== | + | > 补充:指引有3种不同的样式选择(`0, 1, 2`)。 |
- | + | ||
- | ```javascript | + | |
- | function player.ClearKeyPressers() | + | |
- | ``` | + | |
- | + | ||
- | + | ||
- | + | ||
- | ### player.AddGuider() | + | |
- | + | ||
- | > 为玩家建立一个指引目标(屏幕边缘箭头)。 | + | |
```javascript | ```javascript | ||
- | function player.AddGuider( index: int, target: any, autoDestroy: | + | function player.AddGuider( index: int, target: any, style: int = 0, text: string = "" |
/* | /* | ||
index:指引索引(如索引已存在指引,将会替换修改,一个index只能存在并表示一个指引实例),相当于一个标签作用 | index:指引索引(如索引已存在指引,将会替换修改,一个index只能存在并表示一个指引实例),相当于一个标签作用 | ||
target:目标对象(可以是Vector|Entity等类型,分别表示静态坐标与动态跟随目标) | target:目标对象(可以是Vector|Entity等类型,分别表示静态坐标与动态跟随目标) | ||
+ | style:指引样式 | ||
+ | text:指引文字 | ||
autoDestroy:到达指引目标附近是否自动移除指引,默认为false | autoDestroy:到达指引目标附近是否自动移除指引,默认为false | ||
*/ | */ | ||
行 1001: | 行 1031: | ||
```javascript | ```javascript | ||
function player.ExistGuider( index: int ): bool | function player.ExistGuider( index: int ): bool | ||
- | ``` | ||
- | |||
- | |||
- | |||
- | ### player.SetCinematicBorder() | ||
- | |||
- | > 设置玩家屏幕电影边框开关,与客户端API作用相同。 | ||
- | |||
- | ```javascript | ||
- | function player.SetCinematicBorder( active: bool, time: float = 1.0 ): bool | ||
- | ``` | ||
- | |||
- | |||
- | |||
- | ### player.GetCinematicBorder() | ||
- | |||
- | > 获取玩家屏幕电影边框开关。 | ||
- | |||
- | ```javascript | ||
- | function player.GetCinematicBorder(): | ||
``` | ``` | ||
行 1079: | 行 1089: | ||
### player.SetVoiceAuthority() | ### player.SetVoiceAuthority() | ||
- | > 设置玩家语音聊天**权限**开关(或理解为静音),默认开启(`true`)。 | + | > 设置玩家语音聊天**权限**开关(静音\禁言),默认开启(`true`)。 |
> | > | ||
- | > **==注意:此选项必须设置为`true`,玩家才有资格进行说话,否则玩家将无法在语音聊天中说话。==** | + | > **==注意:此选项必须设置为`true`,玩家才有资格进行说话,否则玩家将无法在语音聊天中说话(禁言Muted)。==** |
> | > | ||
> ==**(此选项并非是玩家麦克风控制开关,安全考虑,只有玩家自行按住【说话按键】时才会录入音频)**== | > ==**(此选项并非是玩家麦克风控制开关,安全考虑,只有玩家自行按住【说话按键】时才会录入音频)**== | ||
```javascript | ```javascript | ||
- | function player.SetVoiceWorldMode( active: bool ) | + | function player.SetVoiceAuthority( active: bool ) |
``` | ``` | ||
行 1118: | 行 1128: | ||
function player.GetVoiceIgnore( player: Player ): bool | function player.GetVoiceIgnore( player: Player ): bool | ||
``` | ``` | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ### player.TestVisiblePoint() | ||
+ | |||
+ | > 检测玩家相机是否能看到指定坐标(模糊检测,边缘检测并非绝对准确,模拟本地`Camera.TestVisiblePoint()`)。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.TestVisiblePoint( pos: Vector ): bool | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.SetBackpackOtherTarget() | ||
+ | |||
+ | > 设置玩家**额外的观察背包实例**(除本地对象外的另一个背包)。 | ||
+ | > | ||
+ | > 此功能可扩展许多玩法,例如:商店、交易、背包共享等。 | ||
+ | > | ||
+ | > 如果没有设置其他背包实例,玩家背包UI将仅显示自身对象背包。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.SetBackpackOtherTarget( otherBackpack: | ||
+ | ``` | ||
+ | |||
+ | - `observerMode`:观察模式,默认为`0`(0=可读写,1=只读) | ||
+ | |||
+ | |||
+ | |||
+ | ### player.GetBackpackOtherTarget() | ||
+ | |||
+ | > 获取玩家**额外的观察背包实例**。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.GetBackpackOtherTarget(): | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.SetBackpackTempProp() | ||
+ | |||
+ | > 设置玩家**临时背包物品**(随鼠标移动的临时选项),可设置为`null`。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.SetBackpackTempProp( prop: Prop ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.GetBackpackTempProp() | ||
+ | |||
+ | > 获取玩家**临时背包物品**(随鼠标移动的临时选项),如不存在则为`prop.IsValid() == false`。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.GetBackpackTempProp(): | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.ReturnBackpackTempProp() | ||
+ | |||
+ | > 尝试返回玩家**临时背包物品**(随鼠标移动的临时选项),尝试自动将临时物品添加到背包。 | ||
+ | > | ||
+ | > 此方法与玩家**存在临时物品时关闭背包**效果相同,如果有空位则自动添加到背包并移出临时物品,如果没有空位则触发丢弃事件。 | ||
+ | > | ||
+ | > **注意:有时可能希望处理玩家的背包(例如清空背包),但有可能玩家正在操作临时物品,这样的话`Backpack`常规方式不会处理到临时物品,因此需要留意玩家手中的临时物品。** | ||
+ | |||
+ | ```javascript | ||
+ | function player.ReturnBackpackTempProp(): | ||
+ | ``` | ||
+ | |||
+ | - `return`:是否正常返回(如果没有临时物品,也会返回`true`) | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||