# 索引


# Component

接口
描述
CreateComponent 服务端 给实体创建服务端组件
CreateComponent 客户端 给实体创建客户端组件
DestroyComponent 服务端 删除实体的服务端组件
DestroyComponent 客户端 删除实体的客户端组件
GetComponent 服务端 获取实体的服务端组件。一般用来判断某个组件是否创建过,其他情况请使用CreateComponent
GetComponent 客户端 获取实体的客户端组件。一般用来判断某个组件是否创建过,其他情况请使用CreateComponent
GetComponentCls 服务端 用于获取服务器component基类。实现新的component时,需要继承该接口返回的类
GetComponentCls 客户端 用于获取客户端component基类。实现新的component时,需要继承该接口返回的类
GetEngineCompFactory 服务端 获取引擎组件的工厂,通过工厂可以创建服务端的引擎组件
GetEngineCompFactory 客户端 获取引擎组件的工厂,通过工厂可以创建客户端的引擎组件
RegisterComponent 服务端 用于将组件注册到引擎中
RegisterComponent 客户端 用于将组件注册到引擎中

# System

接口
描述
GetClientSystemCls 客户端 用于获取客户端system基类。实现新的system时,需要继承该接口返回的类
GetServerSystemCls 服务端 用于获取服务器system基类。实现新的system时,需要继承该接口返回的类
GetSystem 服务端 获取已注册的系统
GetSystem 客户端 用于获取其他系统实例
RegisterSystem 服务端 用于将系统注册到引擎中,引擎会创建一个该系统的实例,并在退出游戏时回收。系统可以执行我们引擎赋予的基本逻辑,例如监听事件、执行Tick函数、与客户端进行通讯等。
RegisterSystem 客户端 用于将系统注册到引擎中,引擎会创建一个该系统的实例,并在退出游戏时回收。系统可以执行我们引擎赋予的基本逻辑,例如监听事件、执行Tick函数、与服务端进行通讯等。

# 事件

接口
描述
BroadcastEvent 服务端
客户端
本地广播事件,客户端system广播的事件仅客户端system能监听,服务器system广播的事件仅服务端system能监听。
BroadcastToAllClient 服务端 服务器广播事件到所有客户端
CreateEventData 服务端
客户端
创建自定义事件的数据,eventData用于发送事件。创建的eventData可以理解为一个dict,可以嵌套赋值dict,list和基本数据类型,但不支持tuple
GetEngineNamespace 服务端 获取引擎事件的命名空间。监听引擎事件时,namespace传该接口返回的namespace
GetEngineNamespace 客户端 获取引擎事件的命名空间。监听引擎事件时,namespace传该接口返回的namespace
GetEngineSystemName 服务端 获取引擎系统名。监听引擎事件时,systemName传该接口返回的systemName
GetEngineSystemName 客户端 获取引擎系统名。监听引擎事件时,systemName传该接口返回的systemName
ListenForEvent 服务端
客户端
注册监听某个系统抛出的事件。若监听引擎事件时,namespace和systemName分别为GetEngineNamespace()和GetEngineSystemName()。具体每个事件的详细事件data可以参考"事件"分类下的内容
NotifyToClient 服务端 服务器发送事件到指定客户端
NotifyToMultiClients 服务端 服务器发送事件到指定一批客户端,相比于在for循环内使用NotifyToClient性能更好
NotifyToServer 客户端 客户端发送事件到服务器
UnListenAllEvents 服务端
客户端
反注册监听某个系统抛出的所有事件,即不再监听。
UnListenForEvent 服务端
客户端
反注册监听某个系统抛出的事件,即不再监听。若是引擎事件,则namespace和systemName分别为GetEngineNamespaceGetEngineSystemName。与ListenForEvent对应。

# 本地设备

接口
描述
GetIP 客户端 获取本地玩家的ip地址
GetPlatform 服务端 获取脚本运行的平台
GetPlatform 客户端 获取脚本运行的平台
IsInApollo 服务端 返回当前游戏Mod是否运行在Apollo网络服
IsInServer 服务端 获取当前游戏是否跑在服务器环境下

# 本地存储

接口
描述
GetConfigData 客户端 获取本地配置文件中存储的数据
SetConfigData 客户端 以本地配置文件的方式存储数据

# 数学

接口
描述
GetDirFromRot 服务端 通过旋转角度获取朝向
GetDirFromRot 客户端 通过旋转角度获取朝向
GetLocalPosFromWorld 服务端 获取基于实体的世界坐标对应的局部坐标
GetLocalPosFromWorld 客户端 获取基于实体的世界坐标对应的局部坐标
GetRotFromDir 服务端 通过朝向获取旋转角度
GetRotFromDir 客户端 通过朝向获取旋转角度
GetWorldPosFromLocal 服务端 获取基于实体的局部坐标对应的世界坐标
GetWorldPosFromLocal 客户端 获取基于实体的局部坐标对应的世界坐标

# 工具

接口
描述
AddRepeatedTimer 服务端 添加服务端触发的定时器,重复执行
AddRepeatedTimer 客户端 添加客户端触发的定时器,重复执行
AddTimer 服务端 添加服务端触发的定时器,非重复
AddTimer 客户端 添加客户端触发的定时器,非重复
CancelTimer 服务端 取消定时器
CancelTimer 客户端 取消定时器
CheckNameValid 服务端 检查昵称是否合法,即不包含敏感词
CheckNameValid 客户端 检查昵称是否合法,即不包含敏感词
CheckWordsValid 服务端 检查语句是否合法,即不包含敏感词
CheckWordsValid 客户端 检查语句是否合法,即不包含敏感词
GetChinese 服务端 获取langStr对应的中文,可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang
GetChinese 客户端 获取langStr对应的中文,可参考PC开发包中\handheld\localization\handheld\data\resource_packs\vanilla\texts\zh_CN.lang
GetFps 客户端 获取fps
GetMinecraftEnum 服务端 用于获取枚举值文档中的枚举值
GetMinecraftEnum 客户端 用于获取枚举值文档中的枚举值
GetModConfigJson 客户端 以字典形式返回指定路径的json格式配置文件的内容,文件必须放置在资源包的/modconfigs目录下
GetServerTickTime 服务端 获取服务端引擎上一帧的帧消耗时间
ImportModule 服务端 使用字符串路径导入模块,作用与importlib.import_module类似,但只能导入当前加载的mod中的模块
ImportModule 客户端 使用字符串路径导入模块,作用与importlib.import_module类似,但只能导入当前加载的mod中的模块
StartCoroutine 服务端 开启服务端协程,实现函数分段式执行,可用于缓解复杂逻辑计算导致游戏卡顿问题
StartCoroutine 客户端 开启客户端协程,实现函数分段式执行,可用于缓解复杂逻辑计算导致游戏卡顿问题
StopCoroutine 服务端 停止协程
StopCoroutine 客户端 停止客户端协程

# 调试

接口
描述
GetEnableReconnectNetgame 客户端 获取是否允许断线重连
GetKeepResourceWhenTransfer 客户端 获取快速切服设置
GetMcpModLogCanPostDump 服务端 获取是否可以打印错误信息到McpModLog日志。
GetMcpModLogCanPostDump 客户端 获取是否可以打印错误信息到McpModLog日志。
GetResourceFastload 客户端 获取资源快速加载设置
PostMcpModDump 服务端 主动打印信息到McpModLog日志,需要先调用 SetMcpModLogCanPostDump 接口进行设置,才能生效。
PostMcpModDump 客户端 主动打印信息到McpModLog日志,需要先调用 SetMcpModLogCanPostDump 接口进行设置,才能生效。
ReloadAllMaterials 客户端 重新加载所有材质文件
ReloadAllShaders 客户端 重新加载所有Shader文件
ReloadOneShader 客户端 重新加载某个Shader文件
SetEnableReconnectNetgame 客户端 设置是否允许断线重连
SetKeepResourceWhenTransfer 客户端 设置快速切服
SetMcpModLogCanPostDump 服务端 设置是否可以打印错误信息到McpModLog日志。
SetMcpModLogCanPostDump 客户端 设置是否可以打印错误信息到McpModLog日志。
SetResourceFastload 客户端 设置资源快速加载
StartMemProfile 服务端 开始启动服务端脚本内存分析,启动后调用StopMemProfile即可在路径fileName生成函数内存火焰图,此接口只支持PC端。生成的火焰图可以用浏览器打开,推荐chrome浏览器。
StartMemProfile 客户端 开始启动客户端脚本内存分析,启动后调用StopMemProfile即可在路径fileName生成函数内存火焰图,此接口只支持PC端。生成的火焰图可以用浏览器打开,推荐chrome浏览器。
StartMultiProfile 服务端 开始启动服务端与客户端双端脚本性能分析,启动后调用StopMultiProfile即可在路径fileName生成函数性能火焰图。双端采集时数据误差较大,建议优先使用StartProfile单端版本,此接口只支持PC端
StartMultiProfile 客户端 开始启动服务端与客户端双端脚本性能分析,启动后调用StopMultiProfile即可在路径fileName生成函数性能火焰图。双端采集时数据误差较大,建议优先使用StartProfile单端版本,此接口只支持PC端
StartProfile 服务端 开始启动服务端脚本性能分析,启动后调用StopProfile即可在路径fileName生成函数性能火焰图,此接口只支持PC端。生成的火焰图可以用浏览器打开,推荐chrome浏览器。
StartProfile 客户端 开始启动客户端脚本性能分析,启动后调用StopProfile即可在路径fileName生成函数性能火焰图,此接口只支持PC端。生成的火焰图可以用浏览器打开,推荐chrome浏览器。
StartRecordEvent Apollo 开始启动服务端与客户端之间的脚本事件收发统计,启动后调用StopRecordEvent即可获取两个函数调用之间脚本事件收发的统计信息,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StartRecordPacket Apollo 开始启动服务端与客户端之间的引擎收发包统计,启动后调用StopRecordPacket即可获取两个函数调用之间引擎收发包的统计信息,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StopMemProfile 服务端 停止服务端脚本内存分析并生成火焰图,与StartMemProfile配合使用,此接口只支持PC端
StopMemProfile 客户端 停止客户端脚本内存分析并生成火焰图,与StartMemProfile配合使用,此接口只支持PC端
StopMultiProfile 服务端 停止双端脚本性能分析并生成火焰图,与StartMultiProfile配合使用,此接口只支持PC端
StopMultiProfile 客户端 停止双端脚本性能分析并生成火焰图,与StartMultiProfile配合使用,此接口只支持PC端
StopProfile 服务端 停止服务端脚本性能分析并生成火焰图,与StartProfile配合使用,此接口只支持PC端
StopProfile 客户端 停止客户端脚本性能分析并生成火焰图,与StartProfile配合使用,此接口只支持PC端
StopRecordEvent Apollo 停止服务端与客户端之间的脚本事件收发统计并输出结果,与StartRecordEvent配合使用,输出结果为字典,key为网络包名,value字典中记录收发信息,具体见示例,仅支持租赁服与Apollo网络服环境(不支持单机环境)
StopRecordPacket Apollo 停止服务端与客户端之间的引擎收发包统计并输出结果,与StartRecordPacket配合使用,输出结果为字典,key为网络包名,value字典中记录收发信息,具体见示例,仅支持租赁服与Apollo网络服环境(不支持单机环境)

# 传感器

接口
描述
SetGyroSensorReportRate 客户端 设置陀螺仪传感器(上报/触发)频率
ToggleGyroSensor 客户端 开启或关闭陀螺仪传感器采集