AnvilKitAnvilKit

API 参考

自动生成的 API 文档链接

每个 AnvilKit crate 的自动生成 API 文档可在 docs.rs 上查阅。这些页面直接从源代码和文档注释构建,提供完整的类型签名、trait 实现和示例。

Crate 文档

Crate说明docs.rs
anvilkit-core核心类型 -- Transform、Time、Timer、Persistencedocs.rs/anvilkit-core
anvilkit-app游戏应用运行器 -- GameCallbacks、调度、状态机、ECS 插件系统docs.rs/anvilkit-app
anvilkit-render渲染 -- wgpu、Canvas2D、Canvas3D、PBR 管线、帧捕获、transform 层级docs.rs/anvilkit-render
anvilkit-assets资产管线 -- glTF 加载、动画、MeshData 工厂、AudioAsset、热重载docs.rs/anvilkit-assets
anvilkit-audio音频 -- AudioSource、AudioBus、空间音频、循环/变调docs.rs/anvilkit-audio
anvilkit-input输入 -- 键盘、鼠标、手柄、ActionMap、ActionId、AxisBindingdocs.rs/anvilkit-input
anvilkit-camera摄像机系统 -- 5 种模式、OrbitState、SpringArm、CameraRig、trauma 抖动、过渡、轨道、输入曲线docs.rs/anvilkit-camera
anvilkit-describeAI 优先内省 -- Describe trait 和 derive 宏docs.rs/anvilkit-describe
anvilkit-mcpMCP 服务器 -- 17 个工具(视觉、控制、状态、场景),供 AI 代理交互docs.rs/anvilkit-mcp
anvilkit-gameplay游戏性系统 -- Health、Inventorydocs.rs/anvilkit-gameplay
anvilkit-data数据表(RON/JSON)与 i18n 本地化docs.rs/anvilkit-data
anvilkit总括 crate -- facade、prelude、DefaultPluginsdocs.rs/anvilkit

关键 API

Canvas2D

即时模式 2D 绘图 API,位于 anvilkit_render::renderer::canvas2d

类型说明
Canvas2DRenderer2D 渲染的 GPU 资源。在 init() 中创建一次。
Canvas2D通过 Canvas2D::begin() 获取的每帧绘制上下文。

Canvas2D 方法:clear()draw_rect()draw_text()draw_sprite()finish()

Canvas3D

场景图 3D API,位于 anvilkit_render::renderer::canvas3d

类型说明
Canvas3DRenderer3D 渲染的 GPU 资源。在 init() 中创建一次。
Canvas3D通过 Canvas3D::begin() 获取的每帧 3D 场景上下文。

Canvas3D 方法:clear()spawn_mesh()set_camera()add_light()finish()

帧捕获

Canvas2D 和 Canvas3D 都支持 capture_frame(),返回渲染帧的原始图像字节。这是 AI 优先设计的基础:代理能看到玩家所见。

MCP 工具 (anvilkit-mcp)

MCP 服务器提供 17 个工具,分为四个类别:

类别工具
视觉capture_framedescribe_sceneget_screen_info
控制press_keyrelease_keymove_mouseclickscroll
状态get_componentset_componentlist_entitiesget_resource
场景spawn_objectdespawn_objectsave_sceneload_scenerun_system

本地构建文档

在本地生成并查看 API 文档:

cargo doc --workspace --no-deps --open

此命令为工作区中所有 crate 构建文档,并在浏览器中打开。

目录