UNPKG

sgtcloud-html5-sdk

Version:

A html5 out-of-box sdk for damn cool mbaas

1,681 lines (617 loc) 26.5 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Player</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: Player</h1> <section> <header> <h2> <span class="ancestors"><a href="global.html#SgtApi">SgtApi</a><a href="global.html#SgtApi#entity">.entity</a>.</span> Player </h2> <div class="class-description">Player</div> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="Player"><span class="type-signature"></span>new Player<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> 玩家角色接口 </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line178">line 178</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="customId"><span class="type-signature"></span>customId<span class="type-signature"> :String</span></h4> </dt> <dd> <div class="description"> 自定义ID </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>customId</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>null</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line185">line 185</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="equip"><span class="type-signature"></span>equip<span class="type-signature"> :String</span></h4> </dt> <dd> <div class="description"> 装备 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>equip</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>null</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line192">line 192</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="friendsMaxNumber"><span class="type-signature"></span>friendsMaxNumber<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> 好友最大上限数 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>friendsMaxNumber</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>0</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line255">line 255</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="gender"><span class="type-signature"></span>gender<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> 性别 [1 男 0 女] </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>gender</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>0</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line262">line 262</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :String</span></h4> </dt> <dd> <div class="description"> 主键id </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>0</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line199">line 199</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="lastLoginTime"><span class="type-signature"></span>lastLoginTime<span class="type-signature"> :Long</span></h4> </dt> <dd> <div class="description"> 最后登录时间 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Long</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>lastLoginTime</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>null</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line206">line 206</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="level"><span class="type-signature"></span>level<span class="type-signature"> :int</span></h4> </dt> <dd> <div class="description"> 等级 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">int</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>level</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>1</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line213">line 213</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="money"><span class="type-signature"></span>money<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> 金钱 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>money</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>0</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line269">line 269</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :String</span></h4> </dt> <dd> <div class="description"> 名字 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>null</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line220">line 220</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="serverId"><span class="type-signature"></span>serverId<span class="type-signature"> :String</span></h4> </dt> <dd> <div class="description"> 服务器 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>serverId</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>null</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line227">line 227</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :String</span></h4> </dt> <dd> <div class="description"> 类型 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>null</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line234">line 234</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="userId"><span class="type-signature"></span>userId<span class="type-signature"> :String</span></h4> </dt> <dd> <div class="description"> 用户ID </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>userId</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>null</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line241">line 241</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="vip"><span class="type-signature"></span>vip<span class="type-signature"> :int</span></h4> </dt> <dd> <div class="description"> VIP 等级 </div> <h5>Type:</h5> <ul> <li> <span class="param-type">int</span> </li> </ul> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>vip</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table></dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>0</li> </ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="sgtcloud-html5-sdk.2.0.0.js.html">sgtcloud-html5-sdk.2.0.0.js</a>, <a href="sgtcloud-html5-sdk.2.0.0.js.html#line248">line 248</a> </li></ul></dd> </dl> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-AccountService.html">AccountService</a></li><li><a href="module-AchievementService.html">AchievementService</a></li><li><a href="module-AnnouncementService.html">AnnouncementService</a></li><li><a href="module-BlackListService.html">BlackListService</a></li><li><a href="module-BossService.html">BossService</a></li><li><a href="module-CampaignService.html">CampaignService</a></li><li><a href="module-ChargePoint.html">ChargePoint</a></li><li><a href="module-CheckinBoardService.html">CheckinBoardService</a></li><li><a href="module-DailyTaskService.html">DailyTaskService</a></li><li><a href="module-DelegateDid.html">DelegateDid</a></li><li><a href="module-ErrorReportService.html">ErrorReportService</a></li><li><a href="module-FileStorage.html">FileStorage</a></li><li><a href="module-FriendshipExtra.html">FriendshipExtra</a></li><li><a href="module-FriendshipService.html">FriendshipService</a></li><li><a href="module-GachaBoxService.html">GachaBoxService</a></li><li><a href="module-GiftCode.html">GiftCode</a></li><li><a href="module-InvitationCodeService.html">InvitationCodeService</a></li><li><a href="module-LeaderboardService.html">LeaderboardService</a></li><li><a href="module-MailService.html">MailService</a></li><li><a href="module-Notification.html">Notification</a></li><li><a href="module-PaymentCallbackService.html">PaymentCallbackService</a></li><li><a href="module-PlayerExtraService.html">PlayerExtraService</a></li><li><a href="module-PlayerService.html">PlayerService</a></li><li><a href="module-PrivateChannel.html">PrivateChannel</a></li><li><a href="module-PublicChannelService.html">PublicChannelService</a></li><li><a href="module-Purchase.html">Purchase</a></li><li><a href="module-RouterService.html">RouterService</a></li><li><a href="module-StoreService.html">StoreService</a></li><li><a href="module-StructuredDataService.html">StructuredDataService</a></li><li><a href="module-TaskService.html">TaskService</a></li><li><a href="module-TicketService.html">TicketService</a></li><li><a href="module-TimestampService.html">TimestampService</a></li><li><a href="module-VersionDetailService.html">VersionDetailService</a></li></ul><h3>Classes</h3><ul><li><a href="sendCaptchaMessage.html">sendCaptchaMessage</a></li><li><a href="SgtApi.entity.Achievement.html">Achievement</a></li><li><a href="SgtApi.entity.Announcement.html">Announcement</a></li><li><a href="SgtApi.entity.Blacklist.html">Blacklist</a></li><li><a href="SgtApi.entity.Boss.html">Boss</a></li><li><a href="SgtApi.entity.Campaign.html">Campaign</a></li><li><a href="SgtApi.entity.CampaignDetail.html">CampaignDetail</a></li><li><a href="SgtApi.entity.Channel.html">Channel</a></li><li><a href="SgtApi.entity.ChargeLog.html">ChargeLog</a></li><li><a href="SgtApi.entity.ChargePoint.html">ChargePoint</a></li><li><a href="SgtApi.entity.CheckinBoard.html">CheckinBoard</a></li><li><a href="SgtApi.entity.CheckinResult.html">CheckinResult</a></li><li><a href="SgtApi.entity.DailyTask.html">DailyTask</a></li><li><a href="SgtApi.entity.ExternalCallbackBean.html">ExternalCallbackBean</a></li><li><a href="SgtApi.entity.FileItem.html">FileItem</a></li><li><a href="SgtApi.entity.Friendship.html">Friendship</a></li><li><a href="SgtApi.entity.FriendshipExtra.html">FriendshipExtra</a></li><li><a href="SgtApi.entity.GachaBox.html">GachaBox</a></li><li><a href="SgtApi.entity.GachaBoxResult.html">GachaBoxResult</a></li><li><a href="SgtApi.entity.Gift.html">Gift</a></li><li><a href="SgtApi.entity.GiftRecord.html">GiftRecord</a></li><li><a href="SgtApi.entity.Item.html">Item</a></li><li><a href="SgtApi.entity.LeaderBoard.html">LeaderBoard</a></li><li><a href="SgtApi.entity.LeaderBoardScore.html">LeaderBoardScore</a></li><li><a href="SgtApi.entity.Lottery.html">Lottery</a></li><li><a href="SgtApi.entity.Mail.html">Mail</a></li><li><a href="SgtApi.entity.MailsCollection.html">MailsCollection</a></li><li><a href="SgtApi.entity.MailTemplate.html">MailTemplate</a></li><li><a href="SgtApi.entity.Message.html">Message</a></li><li><a href="SgtApi.entity.Order.html">Order</a></li><li><a href="SgtApi.entity.Player.html">Player</a></li><li><a href="SgtApi.entity.PlayerExtra.html">PlayerExtra</a></li><li><a href="SgtApi.entity.Reward.html">Reward</a></li><li><a href="SgtApi.entity.Save.html">Save</a></li><li><a href="SgtApi.entity.Server.html">Server</a></li><li><a href="SgtApi.entity.Store.html">Store</a></li><li><a href="SgtApi.entity.StructuredData.html">StructuredData</a></li><li><a href="SgtApi.entity.Task.html">Task</a></li><li><a href="SgtApi.entity.Ticket.html">Ticket</a></li><li><a href="SgtApi.entity.TimerTask.html">TimerTask</a></li><li><a href="SgtApi.entity.User.html">User</a></li><li><a href="SgtApi.entity.VersionDetail.html">VersionDetail</a></li><li><a href="SgtApi.init.html">init</a></li></ul> </nav> <br clear="both"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Wed Oct 14 2015 19:20:32 GMT+0800 (中国标准时间) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>