meta data for this page
📚 差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录前一修订版后一修订版 | 前一修订版 | ||
scripting:world:player [2024/03/23 14:34] – bibiboxs | scripting:world:player [2025/06/14 04:24] (当前版本) – bibiboxs | ||
---|---|---|---|
行 13: | 行 13: | ||
> 当新玩家加入到主机房间时调用。 | > 当新玩家加入到主机房间时调用。 | ||
+ | > | ||
+ | > ==注意:此时玩家只是连接成功,并非加载完成,完整加载使用`OnPlayerComplete`。== | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerComplete( player ) | ||
+ | |||
+ | > 当玩家完全加载完成时调用。 | ||
+ | > | ||
+ | > ==此事件是获取玩家完全载入状态的正确方法。== | ||
行 20: | 行 30: | ||
> 当玩家离开房间时调用。 | > 当玩家离开房间时调用。 | ||
- | - **Reason:**离开原因(int) | + | - **Reason:**离开原因(int)(0=断开连接;1=被服务器踢出;2=被服务器封禁) |
行 30: | 行 40: | ||
> 此事件拥有返回值机制,如果返回为`false`则不使用内置的聊天输出机制(将不会输出任何消息),默认返回`true`。 | > 此事件拥有返回值机制,如果返回为`false`则不使用内置的聊天输出机制(将不会输出任何消息),默认返回`true`。 | ||
> | > | ||
- | > *如果有自定义输出聊天样式的需求,可以通过`return 0`然后使用`Message(" | + | > *如果有自定义输出聊天样式的需求,可以通过`return 0`然后使用`Message(" |
+ | > | ||
+ | > **注意:沙盘引擎默认聊天消息经过了`Native.FormatRichText()`格式化,这将使文本支持[URL\@AT\Emoji]等高亮显示,如果有自定义Chat需求并希望支持这些功能,可以在手动发送Message前使用此API格式化一次。** | ||
```javascript | ```javascript | ||
行 38: | 行 50: | ||
// | // | ||
Message(" | Message(" | ||
- | return 0; //这里如果不写return或返回1,则不屏蔽《沙盘引擎》默认聊天输出 | + | |
} | } | ||
``` | ``` | ||
+ | |||
+ | |||
+ | ### OnPlayerNetworkCMD( cmd, arg0, arg1, arg2 ) | ||
+ | |||
+ | > 当接收到来自玩家客户端发送的**CMD消息**时调用,**这是客户端与服务端传输自定义信息的方式之一**。 | ||
+ | > | ||
+ | > **对于一些特殊情况,可以利用`json to string`进行更详细的内容传输。** | ||
+ | |||
+ | [note2] | ||
+ | |||
+ | 注意:`CMD\RPC`传输支持几个基础类型(`int | float | string | bool`)。 | ||
+ | |||
+ | [/note] | ||
行 71: | 行 96: | ||
```javascript | ```javascript | ||
function OnPlayerTypingChange( player: Player, state: bool ) | function OnPlayerTypingChange( player: Player, state: bool ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerVoiceStateChange( player, state ) | ||
+ | |||
+ | > 当玩家语音聊天状态发生改变时调用(正在语音聊天)。 | ||
+ | |||
+ | ```javascript | ||
+ | function OnPlayerVoiceStateChange( player: Player, state: bool ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### OnPlayerFocusEntityChange( player, entity ) | ||
+ | |||
+ | > 当玩家焦点对象发生改变时调用。 | ||
+ | |||
+ | ```javascript | ||
+ | function OnPlayerFocusEntityChange( player: Player, entity: Entity ) | ||
``` | ``` | ||
行 89: | 行 134: | ||
### OnPlayerKeyDown( player, keyTag ) | ### OnPlayerKeyDown( player, keyTag ) | ||
- | > 当玩家按下**服务器绑定按键**时调用,只有服务器绑定的按键才会触发。 | + | > 当玩家按下**服务器监听按键**时调用,只有服务器监听的按键(`RegisterKeyListener`)才会触发。 |
行 95: | 行 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`,决定是否允许后续操作 | ||
行 157: | 行 229: | ||
```javascript | ```javascript | ||
player.Address: | player.Address: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.Data | ||
+ | |||
+ | > 内置的自定义类型属性(建议使用基础类型),可供开发者自行使用,需要自行做好类型Type和生命周期处理。 | ||
+ | |||
+ | ```javascript | ||
+ | player.Data = null; //any | ||
``` | ``` | ||
行 183: | 行 265: | ||
``` | ``` | ||
- | |索引|版本| | + | | 索引 | 版本 |
- | | ------------ | + | | ---- | -------------------- | |
- | |0|概念版(Demo)| | + | | 0 | 标准版(Demo\Steam) | |
- | |1|标准版(Steam)| | + | | 1 |
- | |2|黄金版(Steam)| | + | |
行 200: | 行 281: | ||
``` | ``` | ||
- | |索引|账户类型| | + | | 索引 | 账户类型 |
- | | ------------ | + | | ---- | ------------------------------------- | |
- | |0|概念版、本地用户(可能非安全的)| | + | | 0 | 本地用户,非Steam用户(可能非安全的) | |
- | |1|Steam用户(受SteamID保护)| | + | | 1 | Steam用户(标准版\白金版) | |
行 225: | 行 306: | ||
```javascript | ```javascript | ||
player.FPS: int | player.FPS: int | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.Stats | ||
+ | |||
+ | > 设置玩家自定义信息\状态(短文本,将显示在[TAB]菜单的用户名附近)。 | ||
+ | > | ||
+ | |||
+ | ```javascript | ||
+ | player.Stats = ""; | ||
``` | ``` | ||
行 236: | 行 328: | ||
> | > | ||
> **注意:如果世界被修改时玩家绑定的`Character`已存在,那么将同步`Character`修改为新的World,并且不会解除绑定控制。如果不希望这样,可以提前`player.SetEntity(null)`解除绑定,再修改World。** | > **注意:如果世界被修改时玩家绑定的`Character`已存在,那么将同步`Character`修改为新的World,并且不会解除绑定控制。如果不希望这样,可以提前`player.SetEntity(null)`解除绑定,再修改World。** | ||
+ | > | ||
+ | > **==注意:`player.UniqueWorld`的机制是`10000 + player.ID`,因此应该避免手动将世界设置为`10000`及以上的数值。==** | ||
```javascript | ```javascript | ||
行 246: | 行 340: | ||
> 获取玩家**私人同步世界ID**,此项与`player.World`功能相似,不同的是,如果将某个对象设置为`player.UniqueWorld`,则指定对象只有此玩家可见,哪怕此玩家仍然在默认世界(0)。 | > 获取玩家**私人同步世界ID**,此项与`player.World`功能相似,不同的是,如果将某个对象设置为`player.UniqueWorld`,则指定对象只有此玩家可见,哪怕此玩家仍然在默认世界(0)。 | ||
+ | > | ||
+ | > **==注意:`player.UniqueWorld`的机制是`10000 + player.ID`,因此应该避免手动将世界设置为`10000`及以上的数值。==** | ||
```javascript | ```javascript | ||
行 291: | 行 387: | ||
```javascript | ```javascript | ||
player.Character: | player.Character: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.IsAdmin | ||
+ | |||
+ | > 设置玩家**是否为管理员**,管理员可通过[TAB]菜单进行基础的玩家管理。 | ||
+ | > | ||
+ | > 通常情况下,此属性是一个验证管理员权限的**预制抽象属性**,开发者可考虑自行编写更高级的管理员系统。 | ||
+ | |||
+ | ```javascript | ||
+ | player.IsAdmin = false; | ||
``` | ``` | ||
行 317: | 行 425: | ||
### player.FocusPos | ### player.FocusPos | ||
- | > 获取玩家控制焦点坐标,如果玩家正在控制一个角色,则两者坐标相同(同步于此属性)。 | + | > 获取玩家视角焦点坐标(屏幕中心、准星& |
- | > | + | > |
- | > 在玩家不同视角模式(`Client.Camera.Mode`)下(鸟瞰、第三人称),此部分的坐标获取方式会发生变化。 | + | > 在玩家不同视角模式(`Client.Camera.Mode`)下(鸟瞰、第一人称、第三人称),坐标获取方式会发生变化。 |
- | > | + | > |
- | > 主要表现于:【鸟瞰】基于陆地坐标;【第三人称】屏幕准星焦点 | + | > 主要表现于:[鸟瞰]鼠标坐标、[第三人称]屏幕准星坐标 |
```javascript | ```javascript | ||
player.FocusPos: | player.FocusPos: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### 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 | ||
+ | player.FocusAngleForward: | ||
``` | ``` | ||
行 332: | 行 510: | ||
> 获取玩家正在使用的引擎语言(如果中途改动语言,不会更新)。 | > 获取玩家正在使用的引擎语言(如果中途改动语言,不会更新)。 | ||
- | > | + | > |
> 根据《沙盘引擎》语言机制,通常应该采用此方法作为玩家语言的判定。 | > 根据《沙盘引擎》语言机制,通常应该采用此方法作为玩家语言的判定。 | ||
行 356: | 行 534: | ||
```javascript | ```javascript | ||
- | player.IsTyping: | + | player.IsTyping: |
``` | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.IsComplete | ||
+ | |||
+ | > 获取玩家是否完全加载完毕。 | ||
+ | |||
+ | ```javascript | ||
+ | player.IsComplete: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.IsObserver | ||
+ | |||
+ | > 获取玩家是否当前为相机观察模式(`Client.Camera.IsObserver`)。 | ||
+ | |||
+ | ```javascript | ||
+ | player.IsObserver: | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.VoiceState | ||
+ | |||
+ | > 获取玩家语音聊天状态(是否正在语音聊天)。 | ||
+ | > | ||
+ | > **注意:玩家必须`player.SetVoiceAuthority(true)`给予语音权限(默认),且由玩家主动触发按键才会进行聊天。** | ||
+ | |||
+ | ```javascript | ||
+ | player.VoiceState: | ||
+ | ``` | ||
+ | |||
行 373: | 行 584: | ||
> 设置玩家的相机自由模式开关(`Client.Camera.FreeMode`)。 | > 设置玩家的相机自由模式开关(`Client.Camera.FreeMode`)。 | ||
+ | |||
+ | [note2] | ||
+ | 注意:此模式不会修改鼠标可见状态,因此通常应该手动关闭鼠标可见(Client),已达到随鼠标自由旋转。 | ||
+ | [/note] | ||
```javascript | ```javascript | ||
行 409: | 行 624: | ||
player.AudioReverbExternal = 16; //Forest | player.AudioReverbExternal = 16; //Forest | ||
``` | ``` | ||
+ | |||
行 425: | 行 641: | ||
### Player.Search() | ### Player.Search() | ||
- | > 寻找一个玩家实例(通过模糊查找,通常根据玩家名称,不区分大小写),不存在则返回`null`。 | + | > 寻找一个玩家实例(通过模糊查找,通常根据玩家名称\ID,不区分大小写),不存在则返回`null`。 |
```javascript | ```javascript | ||
行 436: | 行 652: | ||
Player.Search(" | Player.Search(" | ||
Player.Search(" | Player.Search(" | ||
+ | Player.Search(" | ||
``` | ``` | ||
行 471: | 行 688: | ||
- | ### Player.Unban() | + | ### Player.BanUUID() |
+ | |||
+ | > 封禁指定**完整UUID**的玩家(仅在当前服务器运行时生效,重启服务器后将清空封禁列表)。 | ||
+ | |||
+ | ```javascript | ||
+ | function Player.BanUUID( uuid: string ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### Player.UnbanUUID() | ||
+ | |||
+ | > 取消封禁指定**完整UUID**的玩家(仅在当前服务器运行时生效,重启服务器后将清空封禁列表)。 | ||
+ | |||
+ | ```javascript | ||
+ | function Player.UnbanUUID( uuid: string ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### Player.UnbanName() | ||
> 取消封禁指定**完整名称(被封禁时)**的玩家(仅在当前服务器运行时生效,重启服务器后将清空封禁列表)。 | > 取消封禁指定**完整名称(被封禁时)**的玩家(仅在当前服务器运行时生效,重启服务器后将清空封禁列表)。 | ||
+ | > | ||
+ | > **==此方法只能取消由`player.Ban()`执行封禁的玩家,具体逻辑仍然基于UUID。==** | ||
```javascript | ```javascript | ||
- | function Player.Unban( name: string ) | + | function Player.UnbanName( name: string ) |
``` | ``` | ||
行 511: | 行 750: | ||
player.SetEntity(chara); | player.SetEntity(chara); | ||
} | } | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.SetObserver() | ||
+ | |||
+ | [note2] | ||
+ | 此方法已过时,已在新版本移除。 | ||
+ | [/note] | ||
+ | |||
+ | > 设置玩家视角观察对象(`Client.Camera.Target`)。 | ||
+ | > | ||
+ | > 设置为`null`可恢复观察控制`character.Entity`。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.SetObserver( character: Character ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.GetObserver() | ||
+ | |||
+ | [note2] | ||
+ | 此方法已过时,已在新版本移除。 | ||
+ | [/note] | ||
+ | |||
+ | > 获取玩家视角观察对象(`Client.Camera.Target`),如未观察其他角色则返回`character.Entity`,否则返回`null`。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.GetObserver(): | ||
``` | ``` | ||
行 517: | 行 786: | ||
### player.Kick() | ### player.Kick() | ||
- | > 从服务器踢出指定玩家。 | + | > 从服务器踢出玩家。 |
```javascript | ```javascript | ||
行 527: | 行 796: | ||
### player.Ban() | ### player.Ban() | ||
- | > 从服务器封禁指定玩家(仅在当前服务器运行时生效,重启服务器后将清空封禁列表)。 | + | > 从服务器封禁玩家(仅在当前服务器运行时生效,重启服务器后将清空封禁列表)。 |
+ | > | ||
+ | > 如果希望实现持久化的封禁列表,请考虑自行实现维护一个`txt|json`文件表,在每次服务器建立后读取文件+遍历执行`Player.BanUUID()`。 | ||
```javascript | ```javascript | ||
行 674: | 行 945: | ||
``` | ``` | ||
+ | |||
+ | |||
+ | ### player.NetworkRPC() | ||
+ | |||
+ | > 为玩家发送一条RPC指令。 | ||
+ | > | ||
+ | > 目标玩家客户端脚本通过`OnServerNetworkRPC()`接收数据。 | ||
+ | > | ||
+ | > **注意:`CMD\RPC`方法仅支持基础类型,并且会自动类型转换。** | ||
+ | |||
+ | ```javascript | ||
+ | function NetworkRPC( rpc: string, arg0: any, arg1: any, arg2: any ) | ||
+ | ``` | ||
行 682: | 行 966: | ||
> 目标玩家客户端脚本通过`OnServerStreamData()`接收数据。 | > 目标玩家客户端脚本通过`OnServerStreamData()`接收数据。 | ||
> | > | ||
- | > **注意:这里不应该放置特别大的数据内容,否则可能造成网络阻塞。** | + | > **注意:这里不应该放置特别大的数据内容(4096),否则可能造成网络阻塞。** |
```javascript | ```javascript | ||
function player.SendData( number: float, data: string = "" | function player.SendData( number: float, data: string = "" | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.ClientExec() | ||
+ | |||
+ | > 为玩家发送一条**客户端脚本代码**,目标玩家**客户端**将执行对应的脚本代码。 | ||
+ | > | ||
+ | > **注意:这里不应该放置特别大的数据内容(2048),否则可能造成网络阻塞。** | ||
+ | |||
+ | ```javascript | ||
+ | function player.ClientExec( code: string ) | ||
``` | ``` | ||
行 806: | 行 1102: | ||
```javascript | ```javascript | ||
function player.FocusCamera() | function player.FocusCamera() | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.RunTask() | ||
+ | |||
+ | > 为玩家执行一次**倒计时任务**(例如拆除炸弹+UI进度条),每个玩家同一时间只能执行一个任务 | ||
+ | |||
+ | ```javascript | ||
+ | function player.RunTask( time: float, title: string, onComplete: Action, theme: int = 0 ) | ||
+ | ``` | ||
+ | |||
+ | - **`theme`:**范围0~4,表示不同的颜色 | ||
+ | |||
+ | ```javascript | ||
+ | player.RunTask(5, | ||
+ | //C4 Setup | ||
+ | }); | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.StopTask() | ||
+ | |||
+ | > 停止玩家**倒计时任务**。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.StopTask() | ||
``` | ``` | ||
行 896: | 行 1220: | ||
### player.AddGuider() | ### player.AddGuider() | ||
- | > 为玩家建立一个指引目标(屏幕边缘箭头)。 | + | > 为玩家建立一个指引目标(屏幕边缘箭头),允许附加指引文字。 |
```javascript | ```javascript | ||
- | function player.AddGuider( index: int, target: any, autoDestroy: | + | function player.AddGuider( index: int, target: any, text: string = "" |
/* | /* | ||
index:指引索引(如索引已存在指引,将会替换修改,一个index只能存在并表示一个指引实例),相当于一个标签作用 | index:指引索引(如索引已存在指引,将会替换修改,一个index只能存在并表示一个指引实例),相当于一个标签作用 | ||
target:目标对象(可以是Vector|Entity等类型,分别表示静态坐标与动态跟随目标) | target:目标对象(可以是Vector|Entity等类型,分别表示静态坐标与动态跟随目标) | ||
+ | text:指引文字 | ||
autoDestroy:到达指引目标附近是否自动移除指引,默认为false | autoDestroy:到达指引目标附近是否自动移除指引,默认为false | ||
*/ | */ | ||
行 948: | 行 1273: | ||
function player.GetCinematicBorder(): | function player.GetCinematicBorder(): | ||
``` | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.SetVoiceMode() | ||
+ | |||
+ | > 设置玩家语音聊天模式,**默认关闭**。 | ||
+ | > | ||
+ | > ==**如果希望激活语音聊天功能,请为玩家设定一个非关闭的语音模式。**== | ||
+ | |||
+ | ```javascript | ||
+ | function player.SetVoiceMode( mode: int = 0 ) | ||
+ | ``` | ||
+ | |||
+ | | 索引 | 语音聊天模式 | ||
+ | | ---- | -------------- | ------------------------------------------------------------ | | ||
+ | | 0 | 关闭 | ||
+ | | 1 | 全局模式 | ||
+ | | 2 | (频道)组模式 | 发送与接收相同频道组(`VoiceGroup`)的聊天,除特定情况及权限、禁言等 | | ||
+ | |||
+ | |||
+ | |||
+ | ### player.GetVoiceMode() | ||
+ | |||
+ | > 获取玩家语音聊天模式。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.GetVoiceMode(): | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.SetVoiceWorldMode() | ||
+ | |||
+ | > 设置玩家语音聊天世界模式开关(3D空间音频,跟随玩家的实体对象)。 | ||
+ | > | ||
+ | > **此选项可能在部分玩法中提高玩家沉浸感,就像其他玩家真的在不远处说话一样。** | ||
+ | > | ||
+ | > *(可通过`GameRule > voice_worlddistance `控制3D空间声音的传播距离)* | ||
+ | |||
+ | ```javascript | ||
+ | function player.SetVoiceWorldMode( active: bool ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.GetVoiceWorldMode() | ||
+ | |||
+ | > 获取玩家语音聊天世界模式开关。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.GetVoiceWorldMode(): | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.SetVoiceAuthority() | ||
+ | |||
+ | > 设置玩家语音聊天**权限**开关(静音\禁言),默认开启(`true`)。 | ||
+ | > | ||
+ | > **==注意:此选项必须设置为`true`,玩家才有资格进行说话,否则玩家将无法在语音聊天中说话(禁言Muted)。==** | ||
+ | > | ||
+ | > ==**(此选项并非是玩家麦克风控制开关,安全考虑,只有玩家自行按住【说话按键】时才会录入音频)**== | ||
+ | |||
+ | ```javascript | ||
+ | function player.SetVoiceAuthority( active: bool ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.GetVoiceAuthority() | ||
+ | |||
+ | > 获取玩家语音聊天**权限**开关。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.GetVoiceAuthority(): | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.SetVoiceIgnore() | ||
+ | |||
+ | > 设置玩家屏蔽指定玩家语音开关,可用于屏蔽其他玩家的语音输出,但不会屏蔽自身对其他玩家的声音。 | ||
+ | |||
+ | ```javascript | ||
+ | function player.SetVoiceIgnore( player: Player, active: bool ) | ||
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### player.GetVoiceIgnore() | ||
+ | |||
+ | > 获取玩家语音聊天**权限**开关。 | ||
+ | |||
+ | ```javascript | ||
+ | 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`) | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||