宿主接入与版本后端
查看 MarkdownXBase 静态库的版本选择、生命周期和能力边界。
XBase 按 GTA 版本生成独立静态库:
| 目标 | 库 | plugin-sdk |
|---|---|---|
| SA | XBaseSA.lib | plugin_sa |
| VC | XBaseVC.lib | plugin_vc |
| III | XBaseIII.lib | plugin_III |
一个 payload 只能链接一个目标库。不要使用库文件名、头文件或宏把 SA ABI 混入 VC/III。
宿主负责生命周期,推荐顺序如下:
XBase::Log::Init();
void OnGameInit() {
XBase::Core::NotifyGameInit();
}
void OnProcess() {
XBase::Core::Process();
}
// 安装宿主事件回调;同时启用当前版本的运行时保护
XBase::Host::Install({OnGameInit, OnProcess});
const auto domains =
XBase::Core::DomainBit(XBase::Core::Domain::Player) |
XBase::Core::DomainBit(XBase::Core::Domain::Ped) |
XBase::Core::DomainBit(XBase::Core::Domain::Vehicle);
// 掩码会过滤当前库不支持的领域
XBase::Core::Init(domains);
// 卸载前恢复控制器状态
XBase::Core::Shutdown();
XBase::Host::Shutdown();Host::Install() 安装 initGameEvent 与进程事件订阅;Host::Shutdown() 会等待在途回调结束再解除订阅,并按逆序卸载运行时保护。
bool Install(const Callbacks& callbacks);
void Shutdown();
bool IsInstalled();
bool ShowMessage(const char* message);ShowMessage() 在当前版本用游戏内置帮助消息输出 UTF-8 文本;VC/III 内部转换为宽字符,不经过 ImGui。
运行时保护只在对应版本安装:VC 增加剧情资源目录纠正(CDirectory::ReadDirFile)与空文件句柄保护(CFileMgr::Read / CloseFile);SA/VC 同时维护剧情期安全门,供 BulletAssist 在剧情、相机过渡与玩家不可用状态下停止对象访问。
如果宿主自己负责 D3D/ImGui,则不要同时调用 XBase::Hooks::Init() 和 XBase::UI::Init(),避免重复安装 Hook 或创建第二套 ImGui context。
领域能力只表示至少存在一组真实 backend。页面应优先检查细粒度能力:
if (!XBase::HasCapability(XBase::FeatureCapability::PlayerBasicState)) {
// 禁用对应 UI 或显示“不支持当前版本”
return;
}各版本的实际支持情况以 Capabilities.cpp 与 README 能力矩阵为准;运行时行为以能力返回值唯一为准。SA 已收口全部领域;VC/III 只报告已实现的能力,未实现的能力保持 false。
能力为 false 时宿主不得继续调用对应功能。VC/III 的 SetEnabledDomains() 会过滤未支持领域,GetEnabledDomains() 返回实际生效掩码。
flowchart LR
Page[XMenu 页面] --> Bridge[版本适配层]
Bridge --> API[XBase 公共 API]
API --> Backend[当前目标 XBase 后端]
Backend --> Game[GTA 运行时对象]页面只负责输入和显示;游戏对象访问属于 XBase 后端。宿主先将菜单字段转换为 XBase::Vehicle::SpawnOptions 和 SpawnPolicy,再调用 XBase Vehicle session。XBase 负责模型校验、限流、生成、旧车追踪/清理、生命周期恢复和事件队列;XMenu 只负责菜单输入、结果展示以及交通/自动驾驶/版本专属策略。
flowchart LR
Page[XMenu 页面] --> Adapter[纯菜单输入转换]
Adapter --> Session[XBase Vehicle Spawn Session]
Session --> Limit[限流与生成状态]
Session --> Cleanup[旧车追踪与清理]
Session --> Backend[SA/VC/III 版本后端]
Session --> Result[SpawnResult / VehicleEvent]
Result --> Host[XMenu 日志与提示]Vehicle::Process()、World::Process()、Weapon::Process()、Scene::Process()、Teleport::Process()、Visual::Process() 和 BulletAssist::Process() 只能由 Core::Process() 调用。XMenu 不得再调用这些领域的持续处理入口;ProcessHost() 仅处理宿主策略和 UI 事件适配。
自由视角、俯视相机、霓虹、随机作弊等曾属于宿主的功能已由 Camera、VehicleEffects、Cheats 提供,宿主不要重新引入对象访问;XMenu 只保留菜单状态、页面编排和输入转换,XBase 不依赖 MenuState。
这几条是硬约束,写宿主时按它们落文件:
| 约束 | 说明 |
|---|---|
| asi 位置 | 主 asi 只放 plugins\ 或 scripts\,旁边不放载荷文件夹 |
| 载荷位置 | 载荷固定在 <游戏根目录>\XBase\Mods\<宿主名>\<宿主名><机型>.dll |
| 宿主名 | 优先取 asi 导出的 XBasePayloadBaseName(),未导出时按 asi 文件名推导 |
| 共享件 | debug.log、WebView2Loader.dll、XBase.exe 由 XBase 产出,宿主发布包不得自带 |
| 模组数据 | 配置、日志、热键、数据包、网页面板都在 Mods\<宿主名>\ 下,取路径只用 Platform::Mod* / Log::InitForMod / Config::InitForMod |
导出声明必须带 dllexport,只写 extern "C" 链接后不会真的导出,Bootstrap 会退回按文件名推导:
extern "C" __declspec(dllexport) const char* XBasePayloadBaseName() {
return "XMenu";
}Player、Ped、Vehicle、Weapon、World、Visual 这些领域由宿主控制器每帧按自身状态推送运行时选项。因此 Web UI、命令、热键等外部入口不能直接调 Player::SetGodMode 这类独立开关——下一帧就会被覆盖,表现为「点了没反应」。
外部入口必须改宿主持有的状态(XMenu 用 MenuState),由控制器统一推送:
// 外部入口
MenuState::GodMode = enable;
// 控制器每帧
XBase::Player::RuntimeOptions options;
options.godMode = MenuState::GodMode;
XBase::Player::SetRuntimeOptions(options);同一方法带多个布尔参数时(如子弹辅助、雷达选项、武器属性覆盖),按参数名分别落到宿主状态的对应字段。
评论