更新日期:2025年 02月 13日PC游戏Unity接入文档
<h3 style="white-space:normal;">
<span style="font-size:16px;">一、接入配置</span><span style="white-space:pre;"> </span><span style="font-size:14px;"> </span>
</h3>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;"><br />
</span>
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">1.1 导入资源</span><span style="white-space:pre;"> </span><span style="font-size:14px;"> </span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;">在unity项目内导入QuickPCxxx.unitypackage</span><br />
<span style="font-size:14px;">Unity菜单栏 Assets --> Import Package --> Custom Package 选择下载的QuickPCxxx.unitypackage</span>
</p>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;"><br />
</span>
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">1.2 参数配置</span><span style="white-space:pre;"> </span><span style="font-size:14px;"> </span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;">导入成功后,Unity的菜单栏会新增QuickSDK按钮,点击可以设置参数</span>
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">BaseUrl为域名地址(SaaS版本配置:https://qkgamesdk.quickapi.net,部署版本配置自己的域名地址)</span>
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">Product Code在SDK后台创建</span>
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">其他为选填参数:显示任务栏状态,填1时显示;loading样式Style,填1为深色,2为浅色</span>
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;"><br />
</span>
</p>
<p style="font-size:medium;white-space:normal;">
<img src="https://staticsite.quickapi.net/data/newFiles/20241224/20241224143051y2Ax568.png" alt="" />
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;"> </span>
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<h3 style="white-space:normal;">
<span style="font-size:16px;">二、接口调用</span><span style="white-space:pre;"> </span><span style="font-size:16px;"> </span>
</h3>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;">添加 quicksdk 的命名空间using quicksdk</span><br />
<span style="font-size:14px;">如下方法获取 SDK 实例,SDK 接口都通过该实例调用,<span style="color:#E53333;">注意:防沉迷不会有弹窗提醒,SDK会通知退出登录接口onLogoutSuccess</span><span style="color:#E53333;"></span></span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">QuickSDK.getInstance()</pre>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;"> </span>
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.1 设置监听器</span><span style="white-space:pre;"> </span><span style="font-size:14px;"> </span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;">用于接收初始化、登录结果的监听回调</span><br />
<span style="font-size:14px;">调用方法</span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public void setListener(QuickSDKListener quickSDKListener )</pre>
<br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;"> </span><br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;">示例</span>
<p style="font-size:medium;white-space:normal;">
<br />
<span style="font-size:14px;">参考Unity Demo/Assets/demo/EventHandle.cs文件</span><br />
<span style="font-size:14px;">注:onLoginFailed回调包括登录取消和登录失败</span><br />
<span style="font-size:14px;">可以通过ErrorMsg的code来区分,code为2表示登录取消,为3是登录失败</span>
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.2</span><span style="white-space:pre;"> </span><span style="font-size:14px;">初始化</span><span style="white-space:pre;"> </span><span style="font-size:14px;"> </span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">调用方法</span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public void init()</pre>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;"><br />
</span>
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">示例</span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">QuickSDK.getInstance().init();</pre>
<span style="white-space:normal;font-size:14px;color:#E53333;">以下接口都需要在初始化成功之后调用</span><br style="font-size:medium;white-space:normal;" />
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.3</span><span style="white-space:pre;"> </span><span style="font-size:14px;">登录</span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">调用方法</span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public void login()</pre>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;"><br />
</span>
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">示例</span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">QuickSDK.getInstance().login();</pre>
<br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;"> </span><br style="font-size:medium;white-space:normal;" />
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.4 上报角色信息</span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">调用方法</span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public void updateRole(GameRoleInfo gameRoleInfo)</pre>
<br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;"> </span><br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;">GameRoleInfo</span>
<table cellpadding="2" cellspacing="0" border="1" bordercolor="#000000" style="width:1011px;">
<tbody>
<tr>
<td>
<span style="font-size:14px;">字段</span><br />
</td>
<td>
<span style="font-size:14px;">类型</span><br />
</td>
<td>
<span style="font-size:14px;">必要性</span>
</td>
<td>
<span style="font-size:14px;">说明</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">serverID</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">服务器 ID</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">serverName</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">服务器名称</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">gameRoleID</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">角色 ID</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">gameRoleName</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;"></span><span style="font-size:14px;">角色名称</span><span style="font-size:14px;"></span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">vipLevel</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">选传</span><br />
</td>
<td>
<span style="font-size:14px;">角色 VIP 等级</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">gameRoleLevel</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">角色等级</span>
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">partyId</span><br />
</td>
<td>
<span style="font-size:14px;">string</span><br />
</td>
<td>
<span style="font-size:14px;">选传</span><br />
</td>
<td>
<span style="font-size:14px;">帮派id</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">partyName</span><br />
</td>
<td>
<span style="font-size:14px;">string</span><br />
</td>
<td>
<span style="font-size:14px;">选传</span><br />
</td>
<td>
<span style="font-size:14px;">公会社团名称</span><br />
</td>
</tr>
<tr>
<td>
<p>
<span style="font-size:14px;">roleBalance</span>
</p>
</td>
<td>
<span style="font-size:14px;">string</span><br />
</td>
<td>
<span style="font-size:14px;">选传</span><br />
</td>
<td>
<span style="font-size:14px;">角色用户余额</span><br />
</td>
</tr>
</tbody>
</table>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.5 支付</span><span style="white-space:pre;"> </span><span style="font-size:14px;"> </span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public void pay (OrderInfo orderInfo, GameRoleInfo gameRoleInfo)</pre>
<br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;"> </span><br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;">OrderInfo</span>
<table cellpadding="2" cellspacing="0" border="1" bordercolor="#000000" style="width:1011px;">
<tbody>
<tr>
<td>
<span style="font-size:14px;">字段</span><br />
</td>
<td>
<span style="font-size:14px;">类型</span><br />
</td>
<td>
<span style="font-size:14px;">必要性</span>
</td>
<td>
<span style="font-size:14px;">说明</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">goodsID</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">商品 ID,用来识别购买的产品</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">goodsName</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">商品名称</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">goodsDesc</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">商品描述</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">amount</span><br />
</td>
<td>
<span style="font-size:14px;">double</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">支付金额,单位 元</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">cpOrderID</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">必传</span><br />
</td>
<td>
<span style="font-size:14px;">游戏方的订单号</span><br />
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">extrasParams</span><br />
</td>
<td>
<span style="font-size:14px;">String</span><br />
</td>
<td>
<span style="font-size:14px;">选传</span><br />
</td>
<td>
<p>
<span style="font-size:14px;">透传参数</span>
</p>
<p>
<span style="font-size:14px;">请勿传特殊符号,如果无法避免建议进行 base64 编码</span>
</p>
</td>
</tr>
<tr>
<td>
<span style="font-size:14px;">callBackUrl</span><br />
</td>
<td>
<span style="font-size:14px;">string</span><br />
</td>
<td>
<span style="font-size:14px;">选传</span><br />
</td>
<td>
<p>
<span style="font-size:14px;"></span><span style="font-size:14px;">支付回调地址</span><span style="font-size:14px;"></span>
</p>
<p>
<span style="font-size:14px;">可选参数,可配置在后台;优先读取后台配置的回调地址</span><span style="font-size:14px;"></span>
</p>
</td>
</tr>
</tbody>
</table>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.6 退出登录</span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public void logout()</pre>
<br style="font-size:medium;white-space:normal;" />
<span style="white-space:normal;font-size:14px;"> </span><br style="font-size:medium;white-space:normal;" />
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.7 显示个人中心</span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public void userCenter()</pre>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;"><br />
</span>
</p>
<h4 style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">2.8 获取uid</span>
</h4>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;">可以在登录之后再次获取Uid,如果没有登录返回空字符串</span>
</p>
<pre class="brush:js;toolbar:false" style="font-size:medium;">public string getUserId()</pre>
<span style="white-space:normal;font-size:14px;"></span>
<p style="font-size:medium;white-space:normal;">
<br />
</p>
<p style="font-size:medium;white-space:normal;">
<span style="font-size:14px;"> </span>
</p>
<div style="font-size:medium;">
<br />
</div>
<p style="font-size:medium;white-space:normal;">
<br />
</p>