Fast Ref API / Getting Started

v1 → v2 迁移指南

下载 Markdown

本指南说明如何从 v1 迁移到 v2。多数现有代码可原样运行。需要改动的部分如下:(1) Import 方式,(2) slot 类型规则,(3) 将已删除的 select_* 替换为 get_*(select=1)


1. Import 方式变更(必需)

v2(1 行)

from os_fast_ref.api import FastRefAPI

安装 v2 .mzp 时会自动注册 startup 脚本(fast_ref_register_path.ms),Max 启动后即可无需配置路径直接 import。

注意: 若不使用 v2 .mzp 重新安装,单行 import 将无法工作。请务必用最新 MZP 重新安装。


2. 强化 slot 类型规则(需检查)

v2 中 slot 参数仅接受 intboolstrfloat 等会立即抛出 TypeError


3. 新方法(可选)

方法 说明
get_outdated_references() 仅返回 OUTDATED 引用列表
reload_outdated_references() 仅重载 OUTDATED 引用
refresh() 强制重新扫描 InfoNode
get_all_objects / get_skin_meshes / get_skin_bones / get_all_skin_objects / get_duplicate_nodes / get_biped_com / get_biped_nodes Get Nodes 查询 API(select=0|1

现有代码不使用也可以。但若曾使用旧 select_*,请务必查看第 6 节。




After(v2)

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
api.reload_outdated_references()          # 仅重载 OUTDATED
api.export_fbx_all(
    output_folder=r"J:\output",
    preset="Unreal_Ani"                   # 按预设名指定
)
api.update_ui()

6. 已删除的 select_ → get_(select=1)(若适用则必需)

select_reference_nodes / select_duplicate_nodes / select_skin_mesh / select_skin_bones完全删除(无 shim)。调用会抛出 AttributeError

已删除 替换为
select_reference_nodes(...) get_all_objects(slot=..., select=1)
select_duplicate_nodes(...) get_duplicate_nodes(slot=..., select=1)
select_skin_mesh(...) get_skin_meshes(slot=..., select=1)
select_skin_bones(...) get_skin_bones(slot=..., select=1)

若只需查询结果,请使用 select=0(默认)。公共约定与异常见 Get Nodes 概览页。

# Before(已删除 — AttributeError)
# api.select_skin_mesh(slot=0)

# After
api.get_skin_meshes(slot=0, select=1)
💬

Need help with the API?

Open a support ticket or join the community discussion.

联系支持