索引
| 接口 | 端 | 描述 |
|---|---|---|
| GetFrictionAllData | 客户端 | 获取本接口的所有参数 |
| SetPlayerFriction | 客户端 | 设置玩家是否有摩擦力 |
| FrictionMath | 客户端 | 摩擦力计算 |
| FrictionPlay | 客户端 | 在客户端Tick调用,用于实现摩擦力效果 |
| ResetFriction | 客户端 | 重置摩擦力 |
| SetPlayerGameMode | 服务端 | 获取或设置玩家游戏模式 |
| GetPlayerName | 双端 | 获取玩家名称 |
| GetPlayerFps | 客户端 | 获取玩家当前FPS |
| GetPlayerDimension | 双端 | 获取玩家所在维度 |
| GetPlayerPing | 双端 | 获取玩家延迟 |
| SetPlayerRender | 双端 | 设置玩家自定义渲染,自动广播给所有玩家 |
| ResetPlayerRender | 双端 | 重置玩家自定义渲染,自动广播给所有玩家 |
| GetHostPlayerId | 服务端 | 获取房主的玩家id |
GetFrictionAllData
客户端
-
描述
获取本接口的所有参数 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| 无 | 无 | 无 |
-
返回值
{ "MoveTime": MoveTime, "StartMove": StartMove, "LastMotionData": LastMotionData, "PlayerMotion": PlayerMotion } -
备注
无 -
示例 空
SetPlayerFriction
客户端
-
描述
设置玩家是否有摩擦力 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| Bool | bool | 是否有摩擦力 |
-
返回值
无 -
备注
无 -
示例 空
FrictionMath
客户端
-
描述
摩擦力计算,过一段时间后(0.01s),使用AddTimer调用ResetFriction -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| IsStartMove | bool | 是否正在移动 |
-
返回值
无 -
备注
需要在客户端Tick调用FrictionPlay -
示例 空
FrictionPlay
客户端
-
描述
在客户端Tick调用,用于实现摩擦力效果 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| 无 | 无 | 无 |
-
返回值
无 -
备注
无 -
示例 空
ResetFriction
客户端
-
描述
重置摩擦力 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| IsOccupy | bool | 是否有其他优先级内容占用 |
-
返回值
Bool, None 是否需要再次Reset -
备注
无 -
示例 空
SetPlayerGameMode
服务端
-
描述
获取或设置玩家游戏模式 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| GameMode | int | 游戏模式,默认为None,则不设置,返回当前玩家游戏模式 |
-
返回值
当前玩家游戏模式 (int) -
备注
无 -
示例 空
GetPlayerName
双端
-
描述
获取玩家名称 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
-
客户端参数 无
-
返回值
玩家名称 (str) -
备注
无 -
示例 空
GetPlayerFps
客户端
-
描述
获取玩家当前FPS -
参数 无
-
返回值
玩家当前FPS (float) -
备注
无 -
示例 空
GetPlayerDimension
双端
-
描述
获取玩家所在维度 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
-
客户端参数 无
-
返回值
维度id (int) -
备注
无 -
示例 空
GetPlayerPing
双端
-
描述
获取玩家延迟 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
-
返回值
玩家当前延迟(单位:ms) (int) -
备注
无 -
示例 空
SetPlayerRender
双端
-
描述
设置玩家[自定义渲染],自动广播给所有玩家 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| JsonId | str | 配置组件JsonId |
| PlayerId | str | 渲染的玩家id |
| IsKeep | bool | 是否保留原生Steve模型 |
| IsFliterSelf | bool | 本次调用是否过滤掉自己,默认为False |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| JsonId | str | 配置组件JsonId |
| PlayerId | str | 渲染的玩家id,默认为该客户端玩家id |
| IsKeep | bool | 是否保留原生Steve模型 |
| IsBroadcast | bool | 本次调用是否广播给所有玩家,默认为True |
| IsFliterSelf | bool | 本次调用是否过滤掉自己,默认为False |
-
返回值
无 -
备注
-
玩家变身的JsonId将会以Key为
LARenderData的GetModRenderAttrData中 -
通过GetModRenderByAttr接口获取玩家当前的渲染配置,调用此接口前,一定要留意玩家是否本身存在了渲染配置。
LARenderData = LASystem.GetModRenderByAttr(PlayerId, 'LARenderData') # 双端数据,因此不需要填写OnlyClient或者OnlyServer。 -
LARenderData (dict) 数据,包含调用SetPlayerRender时的所有参数
参数名 数据类型 说明 JsonId str 配置组件JsonId PlayerId str 渲染的玩家id IsKeep bool 是否保留原生Steve模型 IsBroadcast bool 本次调用是否广播给所有玩家,服务端调用时一定为True IsFliterSelf bool 本次调用是否过滤掉自己,默认为False
-
-
示例 空
ResetPlayerRender
双端
-
描述
重置玩家[自定义渲染],自动广播给所有玩家 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| JsonId | str | 配置组件JsonId |
| PlayerId | str | 渲染的玩家id, |
| IsKeep | bool | 是否保留原生Steve模型 |
| IsFliterSelf | bool | 本次调用是否过滤掉自己,默认为False |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| JsonId | str | 配置组件JsonId |
| PlayerId | str | 渲染的玩家id,默认为该客户端玩家id |
| IsBroadcast | bool | 本次调用是否广播给所有玩家,默认为True |
| IsKeep | bool | 是否保留原生Steve模型 |
| IsFliterSelf | bool | 本次调用是否过滤掉自己,默认为False |
-
返回值
无 -
备注
-
玩家变身的JsonId将会以Key为
LARenderData的GetModRenderAttrData中 -
通过GetModRenderByAttr接口获取玩家当前的渲染配置,调用此接口前,一定要留意玩家是否本身存在了渲染配置。
LARenderData = LASystem.GetModRenderByAttr(PlayerId, 'LARenderData') # 双端数据,因此不需要填写OnlyClient或者OnlyServer。 -
LARenderData (dict) 数据,包含调用SetPlayerRender时的所有参数
参数名 数据类型 说明 JsonId str 配置组件JsonId PlayerId str 渲染的玩家id IsKeep bool 是否保留原生Steve模型 IsBroadcast bool 本次调用是否广播给所有玩家,服务端调用时一定为True IsFliterSelf bool 本次调用是否过滤掉自己,默认为False
-
-
示例
GetHostPlayerId
服务端
-
描述
获取房主的玩家id -
参数
无 -
返回值
房主的玩家id (str) -
备注
无 -
示例 空