文档中心 | 一键联接，全心服务

更新日期：2025年 12月 26日PC游戏UE版接入文档

<h3> 概述 </h3> 适⽤范围：Unreal Engine 4.x / 5.x 插件名称：QuickSDK <h3> 1. 前置要求 </h3> 项⽬可正常编译/打包 已获取 QuickSDK 插件包（通常为 QuickSDK ⽂件夹，包含 QuickSDK.uplugin ） <h3> 2. 安装插件 </h3> 将插件⽬录复制到项⽬路径 <img src="https://staticsite.quickapi.net/data/newFiles/20251226/202512261900066bPt525.png" alt="" /> 确认路径下存在 <img src="https://staticsite.quickapi.net/data/newFiles/20251226/20251226190019UlhV895.png" alt="" /> <h3> 3. 启⽤插件 </h3> 1、打开 UE 编辑器 2、菜单：Edit → Plugins 3、搜索 QuickSDK 4、勾选启⽤（Enable） 5、按提⽰重启编辑器（如需要） 如果项⽬是 C++ 项⽬，或插件包含 C++ 模块，⾸次启⽤可能触发编译 <h3> 4. 项⽬配置 </h3> QuickSDK 插件导⼊成功并启⽤后，会在 Project Settings 中创建⼀个新的设置项 菜单：Edit → Project Settings 找到：QuickSDK（通常在左侧分类列表中） 你需要在此处配置两个参数： 4.1 BaseUrl 含义：QuickSDK服务的API地址（Base URL） ⽰例： https://api.example.com     要求： 不建议以 / 结尾（若插件内部会拼接路径，避免出现 // ） 4.2 ProductCode 含义：sdk后台创建的产品Code 4.3 Show xxxx Close Button 含义：是否在相关界⾯右上⻆显示关闭按钮，勾选表示显示 其他参数是可选配置，保持默认即可 <img src="https://staticsite.quickapi.net/data/newFiles/20251226/20251226180421PqHA387.png" alt="" /> <h3> 5. 对外 API 总览（Blueprint） </h3> QuickSDK 对外暴露的全部⽅法如下（均位于 UQuickSDKBlueprintLibrary ） SetSDKEventListener(UObject* ListenerObject) （必须优先调⽤） InitSDK() Login(UObject* WorldContextObject) Pay(UObject* WorldContextObject, const FSDKOrderInfo& OrderInfo, const FSDKRoleInfo& RoleInfo) UserCenter(UObject* WorldContextObject) Logout() UpdateRole(const FSDKRoleInfo& RoleInfo) GetUser() → FSDKUserInfo <h3> 6. 推荐接⼊顺序 </h3> 强制要求：在调⽤其他 SDK ⽅法之前，必须先调⽤ SetSDKEventListener 设置监听对象，⽤于接收 SDK 回调 推荐调⽤流程： 1、游戏启动/初始化阶段： SetSDKEventListener(ListenerObject) InitSDK() 2、玩家点击“登录”按钮 Login(WorldContextObject) 3、登录成功后/进⼊游戏后（或⻆⾊升级时） UpdateRole(RoleInfo) （可多次调⽤，上报⻆⾊变更） 4、玩家进⼊“用户中心” UserCenter(WorldContextObject) 5、玩家购买/充值 Pay(WorldContextObject, OrderInfo, RoleInfo) 6、玩家退出登录 Logout() 7、获取当前用户（已登录时 GetUser() （若已登录成功，返回当前用户信息） <h3> 7. ⽅法详细说明 </h3> 7.1 SetSDKEventListener（必须最先调⽤） 函数： SetSDKEventListener(UObject* ListenerObject) 用途：设置 SDK 事件监听对象，⽤于接收 QuickSDK 的各类回调（初始化/登录/⽀付/登出等） 调⽤时机：必须在 InitSDK/Login/Pay/UserCenter/Logout/UpdateRole/GetUser 等其他⽅法前调⽤⼀次 参数： ListenerObject ：⼀个 UObject 实例（通常建议为 GameInstance、Subsystem、或常驻 Manager 对象），⽤于承载回调接收逻辑 建议： ListenerObject 必须在游戏⽣命周期内保持有效（避免被 GC 回收） 建议在 GameInstance 初始化时设置⼀次即可 7.2 InitSDK 函数： InitSDK() ⽤途：初始化 QuickSDK 调⽤时机： SetSDKEventListener 之后，在游戏启动阶段调⽤⼀次 注意： 初始化成功/失败的结果通常通过事件回调返回（由 ListenerObject 接收） 7.3 Login 函数： Login(UObject* WorldContextObject) ⽤途：拉起登录流程 调⽤时机：玩家点击登录按钮时调⽤ 参数： WorldContextObject ：世界上下⽂对象（通常传⼊ Widget、PlayerController、GameInstance 等可提供世界上下⽂的对象） 结果： 登录成功/取消/失败通过 SDK 回调通知（ListenerObject 接收） 登录成功后，可使⽤ GetUser() 获取当前⽤⼾信息 7.4 GetUser 函数： FSDKUserInfo GetUser() ⽤途：获取当前已登录的⽤⼾信息 说明： 如果已经登录成功，会返回当前的⽤⼾信息（ FSDKUserInfo ） 若未登录/⽆有效⽤⼾，返回值内容取决于插件实现（可能为空结构或默认值） 推荐⽤法： 登录成功回调中调⽤⼀次，缓存⽤⼾信息到你的游戏账号系统 需要展⽰⽤⼾信息时再次调⽤ 7.5 Pay 函数： Pay(UObject* WorldContextObject, const FSDKOrderInfo& OrderInfo, const FSDKRoleInfo& RoleInfo) ⽤途：发起⽀付/下单流程 调⽤时机：玩家在商店确认购买时调⽤ 参数： WorldContextObject ：世界上下⽂对象（同 Login/UserCenter） OrderInfo（ FSDKOrderInfo ）：订单信息（商品、订单号、⾦额等，字段以 QuickSDKTypes.h 定义为准） RoleInfo（ FSDKRoleInfo ）：⻆⾊信息（区服、⻆⾊名、等级等，字段以 QuickSDKTypes.h 定义为准） FSDKOrderInfo <table style="width:1000px;" cellpadding="2" cellspacing="0" border="1" bordercolor="#000000"> <tbody> <tr> <td> 字段 </td> <td> 类型 </td> <td> 必要性 </td> <td> 说明 </td> </tr> <tr> <td> GoodsID </td> <td> string </td> <td> 必传 </td> <td> 商品 ID，⽤来识别购买的产品 </td> </tr> <tr> <td> GoodsName </td> <td> string </td> <td> 必传 </td> <td> 商品名称 </td> </tr> <tr> <td> GoodsDesc </td> <td> string </td> <td> 必传 </td> <td> 商品描述 </td> </tr> <tr> <td> Amount </td> <td> double </td> <td> 必传 </td> <td> ⽀付⾦额，单位元 </td> </tr> <tr> <td> CpOrderID </td> <td> string </td> <td> 必传 </td> <td> 游戏方的订单号 </td> </tr> <tr> <td> ExtrasParams </td> <td> string </td> <td> 选传 </td> <td> 透传参数（请勿传特殊符号，如果⽆法避免建议进⾏ base64 编码） </td> </tr> <tr> <td> CallBackUrl </td> <td> string </td> <td> 选传 </td> <td> ⽀付回调地址（可选参数，可配置在后台；优先读取前端传的回调地址） </td> </tr> </tbody> </table> FSDKRoleInfo <table style="width:1000px;" cellpadding="2" cellspacing="0" border="1" bordercolor="#000000"> <tbody> <tr> <td> 字段 </td> <td> 类型 </td> <td> 必要性 </td> <td> 说明 </td> </tr> <tr> <td> ServerId </td> <td> string </td> <td> 必传 </td> <td> 服务器 ID                                                                                      </td> </tr> <tr> <td> ServerName </td> <td> string </td> <td> 必传 </td> <td> 服务器名称 </td> </tr> <tr> <td> RoleID </td> <td> string </td> <td> 必传 </td> <td> 角色ID </td> </tr> <tr> <td> RoleName </td> <td> string </td> <td> 必传 </td> <td> ⻆⾊名称 </td> </tr> <tr> <td> RoleLevel </td> <td> string </td> <td> 必传 </td> <td> ⻆⾊等级 </td> </tr> </tbody> </table> 7.6 UserCenter 函数： UserCenter(UObject* WorldContextObject) 用途：打开用户中心界面 调⽤时机：玩家点击“用户中心/账号中心”入口时调⽤ 参数： WorldContextObject ：世界上下⽂对象 7.7 Logout 函数： Logout() ⽤途：退出登录 调⽤时机：玩家主动登出时调⽤ 结果： 登出结果/状态变化通常通过回调通知（ListenerObject 接收） 登出后 GetUser() 通常不应再返回有效用户信息 7.8 UpdateRole 函数： UpdateRole(const FSDKRoleInfo& RoleInfo) 用途：上报⻆⾊信息到 SDK 后台 调⽤时机（建议）： 进⼊游戏/进⼊主城/⻆⾊创建完成后调⽤⼀次 ⻆⾊升级时再次调⽤ 关键属性变化（如区服切换、⻆⾊名变更）时调⽤ 参数： FSDKRoleInfo <table style="width:1000px;" cellpadding="2" cellspacing="0" border="1" bordercolor="#000000"> <tbody> <tr> <td> 字段 </td> <td> 类型 </td> <td> 必要性 </td> <td> 说明 </td> </tr> <tr> <td> ServerId </td> <td> string </td> <td> 必传 </td> <td> 服务器 ID </td> </tr> <tr> <td> ServerName </td> <td> string </td> <td> 必传 </td> <td> 服务器名称 </td> </tr> <tr> <td> RoleID </td> <td> string </td> <td> 必传 </td> <td> 角色ID </td> </tr> <tr> <td> RoleName </td> <td> string </td> <td> 必传 </td> <td> 角色名称 </td> </tr> <tr> <td> VipLevel </td> <td> string </td> <td> 选传 </td> <td> 角色 VIP 等级 </td> </tr> <tr> <td> RoleLevel </td> <td> string </td> <td> 必传 </td> <td> 角色等级 </td> </tr> <tr> <td> PartyID </td> <td> string </td> <td> 选传 </td> <td> 帮派id </td> </tr> <tr> <td> PartyName </td> <td> string </td> <td> 选传 </td> <td> 公会社团名称 </td> </tr> <tr> <td> RoleBalance </td> <td> string </td> <td> 选传 </td> <td> 角色用户余额 </td> </tr> </tbody> </table> <h3> 8. 蓝图接⼊示例（推荐实现方式） </h3> 这⾥提供“接入方最容易落地”的实践：用 GameInstance（或 Subsystem）做 ListenerObject，统⼀接收回调；UI 只负责触发 Login/Pay/UserCenter 等 8.1 初始化阶段（GameInstance） 在 GameInstance 蓝图的 Event Init ： 调⽤ SetSDKEventListener(Self) 调⽤ InitSDK 8.2 登录按钮 UI Widget 的登录按钮 OnClicked ： 调⽤ Login(Self) （或传 PlayerController 等可⽤的 WorldContextObject） 8.3 进⼊游戏/升级上报⻆⾊ 进⼊游戏时调⽤： UpdateRole(RoleInfo) 升级时再次调⽤： UpdateRole(RoleInfo) （更新 Level 字段等） 8.4 ⽀付按钮 1、组装 OrderInfo 与 RoleInfo 2、调⽤ Pay(Self, OrderInfo, RoleInfo) 8.5 用户中心与登出 用户中心按钮： UserCenter(Self) 登出按钮： Logout() <h3> 9. 可选：接⼊ Steam SDK（Steamworks） </h3> 若项⽬不使⽤ Steam，可跳过 9.1 资源拷贝要求 QuickSDK 插件在集成 Steamworks 时，依赖 Steamworks SDK 的⽬录资源。 Steamworks ⽬录复制到以下路径： ⽬标路径（QuickSDK 插件内） QuickSDKSourceThirdPartySteamworks 也就是说，最终⽬录结构应类似如下（示例）： YourProject/Plugins/QuickSDK/Source/ThirdParty/Steamworks/... 9.2 测试配置 Steam测试需要在程序根⽬录创建⼀个 steam_appid.txt ⽂件，⽂件⾥⾯只写⼊steam的appId <div> </div>