REFramework Lua API

关于

这是一个测试版本，尚未包含完整的REFramework API。

这是一个由REFramework C++代码生成的Lua封装库，附带HTML文档以创建简易Lua库。该库封装了REFramework API，为您的模组提供完整的智能感知、强类型支持、文档说明以及详细的错误信息。

应用程序编程接口

• draw
• ffi
• imgui
• json
• log
• re
• reframework
• sdk
• types（类型定义）

它还包括一些在模组开发中常用的实用功能：

函数名	说明
write_valuetype	写入值类型
find_index	查找索引
merge_tables	合并表格
table_contains	表格包含
generate_statics	生成统计
save_config	保存配置
load_config	加载配置
vec2_tostring	二维向量转字符串
vec3_tostring	三维向量转字符串
vec4_tostring	四维向量转字符串
get_components	获取组件
get_component	获取组件
get_transform	获取变换
get_fields_by_type	按类型获取字段
get_fields	获取字段

编辑器

这应该适用于任何支持Lua语言服务器的编辑器 - 比如VS Code或安装了Lua插件/扩展的Neovim。

你可能需要在编辑器中打开整个autorun文件夹，这样它才能看到所有文件并正确自动补全。

安装

只需将此API与 REFramework 一起复制到游戏安装目录中。然后你就可以在脚本中引用并使用它。如果你发布使用此API的模组，只需将其标记为必备项。

local api = require("REFrameworkAPI")

local vec = api.types.Vector2f:new(1.0, 2.0)

api.sdk.hook(
    api.sdk.find_type_definition("app.ItemManager"):get_method("getStorageWeight"),
    功能（参数）
    结束，
    函数(返回值)
        return rtval
    结束
)