meta data for this page
  •  

📚 差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录前一修订版
后一修订版		前一修订版
scripting:world:player [2024/08/08 04:20] – bibiboxsscripting:world:player [2025/07/26 22:49] (当前版本) – bibiboxs
行 54: 行 54:
 ``` ```
  
 +
 +
 +### OnPlayerNetworkCMD( cmd, arg0, arg1, arg2 )
 +
 +> 当接收到来自玩家客户端发送的**CMD消息**时调用，**这是客户端与服务端传输自定义信息的方式之一**。
 +>
 +> **对于一些特殊情况，可以利用`json to string`进行更详细的内容传输。**
 +
 +[note2]
 +
 +注意：`CMD\RPC`传输支持几个基础类型（`int | float | string | bool`）。
 +
 +[/note]
  
  
行 93: 行 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 )
 ``` ```
  
行 111: 行 134:
 ### OnPlayerKeyDown( player, keyTag ) ### OnPlayerKeyDown( player, keyTag )
  
-> 当玩家按下**服务器绑定按键**时调用，只有服务器绑定的按键才会触发。+> 当玩家按下**服务器监听按键**时调用，只有服务器监听的按键（`RegisterKeyListener`）才会触发。
  
  
行 117: 行 140:
 ### OnPlayerKeyUp( player, keyTag ) ### OnPlayerKeyUp( player, keyTag )
  
-> 当玩家抬起**服务器绑定按键**时调用，只有服务器绑定的按键才会触发。+> 当玩家抬起**服务器监听按键**时调用，只有服务器监听的按键（`RegisterKeyListener`）才会触发。
  
  
  
-### OnPlayerNativeKeyDown( player, keyTag )+### OnPlayerWorldChange( player, world )
  
-> 当玩家按下**服务器监听的原生公开按键**时调用，只有服务器监听的原生按键才会触发。+> 当玩家世界ID发生改变时调用。
  
  
  
-### OnPlayerNativeKeyUp( player, keyTag )+### OnPlayerColorChange( player, color )
  
-> 当玩家抬起**服务器监听的原生公开按键**时调用，只有服务器监听的原生按键才会触发。+> 当玩家颜色发生改变时调用。
  
  
  
-### OnPlayerWorldChange( player, world )+### OnPlayerNameChange( player, name )
  
-> 当玩家世界ID发生改变时调用。+> 当玩家名称发生改变时调用。
  
  
  
-### OnPlayerColorChange( player, color )+### OnPlayerBackpackPropOperation( player, slot, isMain, isShift )
  
-> 当玩家颜色发生改变时调用。+> 当玩家背包请求操作物品时调用。 
 +> 
 +> 此方法可配合`player.GetBackpackTempProp()`使用。 
 + 
 +- `isMain`：是否为左键（主要）点击（否则为右键） 
 +- `isShift`：是否按住Shift键 
 +- `return`：默认返回`true`，决定是否允许后续操作 
 + 
 + 
 + 
 +### OnPlayerBackpackPropDiscard( player, prop, isDelete ) 
 + 
 +> 当玩家背包请求扔掉物品时调用。 
 + 
 +- `isDelete`：是否为请求删除物品（否则视为丢弃） 
 +- `return`：默认返回`true`，决定是否允许后续操作
  
  
行 229: 行 267:
 | 索引 | 版本                 | | 索引 | 版本                 |
 | ---- | -------------------- | | ---- | -------------------- |
-| 0    | 免费版（Demo\Steam） | +| 0    | 标准版（Demo\Steam） | 
-| 1    | 标准版（Steam）      |+| 1    | 白金版（Steam+DLC）      |
  
  
行 246: 行 284:
 | ---- | ------------------------------------- | | ---- | ------------------------------------- |
 | 0    | 本地用户，非Steam用户（可能非安全的） | | 0    | 本地用户，非Steam用户（可能非安全的） |
-| 1    | Steam用户（包含免费版+标准版）        |+| 1    | Steam用户（标准版\白金版）        |
  
  
行 349: 行 387:
 ```javascript ```javascript
 player.Character: Character player.Character: Character
 +```
 +
 +
 +
 +### player.IsAdmin
 +
 +> 设置玩家**是否为管理员**，管理员可通过[TAB]菜单进行基础的玩家管理。
 +> 
 +> 通常情况下，此属性是一个验证管理员权限的**预制抽象属性**，开发者可考虑自行编写更高级的管理员系统。
 +
 +```javascript
 +player.IsAdmin = false;
 ``` ```
  
行 375: 行 425:
 ### player.FocusPos ### player.FocusPos
  
-> 获取玩家控制焦点坐标，如果玩家正在控制一个角色，则两者坐标相同（同步于此属性）。+> 获取玩家视角焦点坐标（屏幕中心、准星&鼠标位置）。
 > >
-> 在玩家不同视角模式（`Client.Camera.Mode`）下（鸟瞰、第三人称），坐标获取方式会发生变化。+> 在玩家不同视角模式（`Client.Camera.Mode`）下（鸟瞰、第一人称、第三人称），坐标获取方式会发生变化。
 > >
-> 主要表现于：【鸟瞰】基于陆地坐标；【第三人称】屏幕准星焦点+> 主要表现于：[鸟瞰]鼠标坐标、[第三人称]屏幕准星坐标
  
 ```javascript ```javascript
行 387: 行 437:
  
  
-### player.FocusAngle+### player.FocusEntity
  
-> 设置&获取玩家**控制焦点（游戏视角+屏幕方向）**角度（`Vector2(x, y)`）。+> 获取玩家**视角焦点实体**，如果不存在则返回`null`。 
 + 
 +```javascript 
 +player.FocusEntity: Entity 
 +``` 
 + 
 + 
 + 
 +### player.FocusEntityDistance 
 + 
 +> 获取玩家**视角焦点实体检测距离**，此数值直接影响`FocusEntity`的检测结果，默认距离为`3.0`（`0.0~512.0`）。 
 +>  
 +> **注意：对于远距离视角、鸟瞰视角等情况，应该在合理范围内调高此数值，否则可能距离过短导致无法正确检测。** 
 + 
 +```javascript 
 +player.FocusEntityDistance: float 
 +``` 
 + 
 + 
 + 
 +### player.FocusVAngle 
 + 
 +> 设置&获取玩家**控制视角上下角度**（`Camera.VAngle`）。 
 + 
 +```javascript 
 +player.FocusVAngle: float 
 +``` 
 + 
 + 
 + 
 +### player.FocusHAngle 
 + 
 +> 设置&获取玩家**控制视角横向角度**（`Camera.HAngle`）。 
 + 
 +```javascript 
 +player.FocusHAngle: float 
 +``` 
 + 
 + 
 + 
 +### player.FocusEulerAngle 
 + 
 +> 设置&获取玩家**控制焦点（游戏视角+屏幕方向）**XY角度（`Vector2(x, y)`）。
 > >
-> 在玩家不同视角模式（`Client.Camera.Mode`）下（鸟瞰、第三人称），坐标获取方式会发生变化。+> 在玩家不同视角模式（`Client.Camera.Mode`）下，坐标处理方式会发生变化。 
 + 
 +[note2] 
 +注意：多数情况下，应该使用`Client\Camera`实现视角相关逻辑。 
 +[/note]
  
 ```javascript ```javascript
 player.FocusAngle: Vector2 player.FocusAngle: Vector2
 +```
 +
 +
 +
 +### player.FocusAngleForward
 +
 +> 获取玩家**控制焦点**前方向量。
 +>
 +> 在玩家不同视角模式（`Client.Camera.Mode`）下，坐标处理方式会发生变化。
 +
 +```javascript
 +player.FocusAngleForward: Vector2
 ``` ```
  
行 476: 行 584:
  
 > 设置玩家的相机自由模式开关（`Client.Camera.FreeMode`）。 > 设置玩家的相机自由模式开关（`Client.Camera.FreeMode`）。
 +
 +[note2]
 +注意：此模式不会修改鼠标可见状态，因此通常应该手动关闭鼠标可见（Client），已达到随鼠标自由旋转。
 +[/note]
  
 ```javascript ```javascript
行 529: 行 641:
 ### Player.Search() ### Player.Search()
  
-> 寻找一个玩家实例（通过模糊查找，通常根据玩家名称，不区分大小写），不存在则返回`null`。+> 寻找一个玩家实例（通过模糊查找，通常根据玩家名称\ID，不区分大小写），不存在则返回`null`。
  
 ```javascript ```javascript
行 540: 行 652:
 Player.Search("Tomm"); //Tommy（相似匹配） Player.Search("Tomm"); //Tommy（相似匹配）
 Player.Search("To"); //Tommy（以最先搜索到的为主） Player.Search("To"); //Tommy（以最先搜索到的为主）
 +Player.Search("0"); //By ID
 ``` ```
  
行 643: 行 756:
 ### player.Kick() ### player.Kick()
  
-> 从服务器踢出指定玩家。+> 从服务器踢出玩家。
  
 ```javascript ```javascript
行 653: 行 766:
 ### player.Ban() ### player.Ban()
  
-> 从服务器封禁指定玩家（仅在当前服务器运行时生效，重启服务器后将清空封禁列表）。+> 从服务器封禁玩家（仅在服务器运行时生效，重启服务器将清空封禁列表）。
 > >
 > 如果希望实现持久化的封禁列表，请考虑自行实现维护一个`txt|json`文件表，在每次服务器建立后读取文件+遍历执行`Player.BanUUID()`。 > 如果希望实现持久化的封禁列表，请考虑自行实现维护一个`txt|json`文件表，在每次服务器建立后读取文件+遍历执行`Player.BanUUID()`。
行 660: 行 773:
 function player.Ban( reason: string = "Banned" ) function player.Ban( reason: string = "Banned" )
 ``` ```
- 
- 
- 
-### player.CreateNativeMenu() 
- 
-> 为玩家建立一个`NativeMenu`菜单（[NativeMenu菜单](scripting/extend/nativemenu)），用法与[客户端NativeMenu](scripting/client/main)相同。 
- 
-```javascript 
-let view = { 
-    Cover: 5, 
-    Tag: "Test", 
-    Title: "XXX", 
-    Info: "ABC", 
-    Width: 500, 
-    Align: 1, 
-    Layout: 1, 
-    Items: [ 
-        { 
-            Text: "点击：输出玩家Name", 
-            OnClick: () => { 
-                DLog("PlayerName: " + player.Name); 
-            } 
-        },{ 
-            Input: "xxx", 
-            Restrict: "*", 
-            OnFocus: (text) => { 
-                DLog("输入框文本: " + text); 
-            } 
-        },{ 
-            Text: "点击：刷一辆载具+关闭菜单", 
-            OnClick: () => { 
-                Vehicle.Create(10, player.Entity.Pos, player.Entity.Angle); 
-                player.DestroyNativeMenu(); 
-            } 
-        } 
-    ] 
-}; 
- 
-player.CreateNativeMenu(view); 
-``` 
- 
- 
- 
-### player.DestroyNativeMenu() 
- 
-> 为玩家关闭`NativeMenu`菜单，用法与[客户端NativeMenu](scripting/client/main)相同。 
- 
- 
- 
-### player.SetNativeMenuText() 
- 
-> 为玩家关闭`NativeMenu`菜单，用法与[客户端NativeMenu](scripting/client/main)相同。 
  
  
行 745: 行 806:
  
  
-### player.StoryDialog()+### player.NetworkRPC()
  
-> 为玩家发送一条**故事对话框**消息，并加入到队列中，等待上次对话框结束后陆续执行。+> 为玩家发送一条RPC指令。
 > >
-> **解释：此方法执行后可能不会立即显示，默认会加入到队列中，按加入顺序依次执行历史对话框。**+> 目标玩家客户端脚本通过`OnServerNetworkRPC()`接收数据。 
 +> 
 +> **注意：`CMD\RPC`方法仅支持基础类型，并且会自动类型转换。**
  
 ```javascript ```javascript
-function player.StoryDialog( title: string, text: string, avatar: int = -1, sound: int = -1, buttons: any = null, onComplete: Action = null )+function NetworkRPC( rpc: string, arg0: any, arg1: any, arg2: any )
 ``` ```
  
-- **title：**标题、故事对话人昵称 
-- **text：**主要文本内容（可用`html`语法，以及`\n`换行） 
-- **avatar：**故事对话人形象图片ID（基于Texture文件机制），默认为`-1` 
-- **sound：**故事对话时音频ID（例如配音等，基于Sound文件机制），默认为`-1`，仅在当前对话框生命周期有效，对话结束（或切换对话框）后将自动停止播放 
-- **buttons：**附加按钮（最多支持3个），以数组的形式传递数据（见下方示例） 
-- **onComplete：**对话结束时触发事件 
  
-```javascript 
-player.StoryDialog("测试角色", "风平浪静……", -1, -1, [ 
-    { 
-        Button: "Button A",  
-        Action: () => { 
-            DLog("Click A"); 
-        } 
-    },{ 
-        Button: "Button B",  
-        Action: () => { 
-            DLog("Click B"); 
-        } 
-    } 
-], () => { 
-    DLog("OnComplete Invoke!"); 
-}); //1 
-player.StoryDialog("测试角色2", "风平浪静1……", -1, 1124); //2 
-player.StoryDialog("测试角色2", "风平浪静2……", -1, 1124); //3 
-``` 
  
 +### player.SendData()
  
- +> 为玩家发送一条**服务端>客户端**的自定义Stream数据信息。 
-### 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() +
- +
-> 为玩家发送一条**服务端>客户端**的自定义Stream数据信息。+
 > >
-> 目标玩家客户端脚本通过`OnServerStreamData()`接收数据。 +> **注意：这里不应该放置特别大的数据内容（2048），否则可能造成网络阻塞。**
-> +
-> **注意：这里不应该放置特别大的数据内容，否则可能造成网络阻塞。**+
  
 ```javascript ```javascript
-function player.SendData( number: float, data: string = "" )+function player.ClientExec( code: string )
 ``` ```
  
行 938: 行 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.AddKeyPresser( index: int, keyCode: string, text: string, onPress: Action = null ) +player.RunTask(5, "正在安装C4...", () => { 
-/* +    //C4 Setup 
- index：指引索引（如索引已存在指引，将会替换修改，一个index只能存在并表示一个指引实例），相当于一个标签作用 +});
- keyCode：绑定按键，最好不要和其他按键冲突，除非知道在做什么 +
- text：按键后面的文本内容 +
- onPress：当玩家按下后执行的事件 +
-*/ +
- +
-//通常情况下，如果同时只使用1个指引功能，只需要一直将index填写0即可 +
-//在可能处理多个按键对象的情况下，可以将index作为区分标签作用，比如上车index是100，下车可能是101，这样可以随时用ExistKeyPresser来检查某个按键对象是否存在+
 ``` ```
  
-```javascript 
-//同时绑定多个按键对象的示例 
-player.AddKeyPresser(0, "F", "进入当前载具", () => { 进入代码... }); 
-player.AddKeyPresser(3, "H", "修复当前载具", () => { 修复代码... }); 
  
-//此时将会在玩家屏幕中，显示竖向的两行（最多支持6行） 
-【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: bool = false )+function player.AddGuider( index: int, target: any, style: int = 0, text: string = "", autoDestroy: bool = false )
 /* /*
  index：指引索引（如索引已存在指引，将会替换修改，一个index只能存在并表示一个指引实例），相当于一个标签作用  index：指引索引（如索引已存在指引，将会替换修改，一个index只能存在并表示一个指引实例），相当于一个标签作用
  target：目标对象（可以是Vector|Entity等类型，分别表示静态坐标与动态跟随目标）  target：目标对象（可以是Vector|Entity等类型，分别表示静态坐标与动态跟随目标）
 + style：指引样式
 + text：指引文字
  autoDestroy：到达指引目标附近是否自动移除指引，默认为false  autoDestroy：到达指引目标附近是否自动移除指引，默认为false
 */ */
行 1055: 行 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(): bool 
 ``` ```
  
行 1133: 行 1089:
 ### player.SetVoiceAuthority() ### player.SetVoiceAuthority()
  
-> 设置玩家语音聊天**权限**开关（或理解为静音），默认开启（`true`）。+> 设置玩家语音聊天**权限**开关（静音\禁言），默认开启（`true`）。
 > >
-> **==注意：此选项必须设置为`true`，玩家才有资格进行说话，否则玩家将无法在语音聊天中说话。==**+> **==注意：此选项必须设置为`true`，玩家才有资格进行说话，否则玩家将无法在语音聊天中说话（禁言Muted）。==**
 > >
 > ==**（此选项并非是玩家麦克风控制开关，安全考虑，只有玩家自行按住【说话按键】时才会录入音频）**== > ==**（此选项并非是玩家麦克风控制开关，安全考虑，只有玩家自行按住【说话按键】时才会录入音频）**==
  
 ```javascript ```javascript
-function player.SetVoiceWorldMode( active: bool )+function player.SetVoiceAuthority( active: bool )
 ``` ```
  
行 1172: 行 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: Backpack, observerMode: int = 0 )
 +```
 +
 +- `observerMode`：观察模式，默认为`0`（0=可读写，1=只读）
 +
 +
 +
 +### player.GetBackpackOtherTarget()
 +
 +> 获取玩家**额外的观察背包实例**。
 +
 +```javascript
 +function player.GetBackpackOtherTarget(): Backpack
 +```
 +
 +
 +
 +### player.SetBackpackTempProp()
 +
 +> 设置玩家**临时背包物品**（随鼠标移动的临时选项），可设置为`null`。
 +
 +```javascript
 +function player.SetBackpackTempProp( prop: Prop )
 +```
 +
 +
 +
 +### player.GetBackpackTempProp()
 +
 +> 获取玩家**临时背包物品**（随鼠标移动的临时选项），如不存在则为`prop.IsValid() == false`。
 +
 +```javascript
 +function player.GetBackpackTempProp(): Prop
 +```
 +
 +
 +
 +### player.ReturnBackpackTempProp()
 +
 +> 尝试返回玩家**临时背包物品**（随鼠标移动的临时选项），尝试自动将临时物品添加到背包。
 +>
 +> 此方法与玩家**存在临时物品时关闭背包**效果相同，如果有空位则自动添加到背包并移出临时物品，如果没有空位则触发丢弃事件。
 +>
 +> **注意：有时可能希望处理玩家的背包（例如清空背包），但有可能玩家正在操作临时物品，这样的话`Backpack`常规方式不会处理到临时物品，因此需要留意玩家手中的临时物品。**
 +
 +```javascript
 +function player.ReturnBackpackTempProp(): bool
 +```
 +
 +- `return`：是否正常返回（如果没有临时物品，也会返回`true`）
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +