sgtcloud-html5-sdk
Version:
A html5 out-of-box sdk for damn cool mbaas
1,214 lines (377 loc) • 20.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: GachaBox</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: GachaBox</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="global.html#SgtApi">SgtApi</a><a href="global.html#SgtApi#entity">.entity</a>.</span>
GachaBox
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="GachaBox"><span class="type-signature"></span>new GachaBox<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#line1748">line 1748</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="continuousPrice"><span class="type-signature"></span>continuousPrice<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">
<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#line1754">line 1754</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="description"><span class="type-signature"></span>description<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
描述
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<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#line1760">line 1760</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="endValidTime"><span class="type-signature"></span>endValidTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
有效期，从yyyyMMddHHMM到yyyyMMddHHMM 精确到分钟
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<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#line1766">line 1766</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="id"><span class="type-signature"></span>id<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">
<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#line1772">line 1772</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="img"><span class="type-signature"></span>img<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
图片
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<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#line1778">line 1778</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="initQuality"><span class="type-signature"></span>initQuality<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
初始品质，默认0
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<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#line1784">line 1784</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="lotteries"><span class="type-signature"></span>lotteries<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
瞬时属性，保存该GachaBox下所有奖励
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<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#line1790">line 1790</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="maxQuality"><span class="type-signature"></span>maxQuality<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
最大限制品质，默认0不限制
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<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#line1796">line 1796</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
名称（同一服务器不能重复）
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<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#line1802">line 1802</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="price"><span class="type-signature"></span>price<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">
<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#line1808">line 1808</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="startValidTime"><span class="type-signature"></span>startValidTime<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
有效期，从yyyyMMddHHMM到yyyyMMddHHMM 精确到分钟
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<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#line1814">line 1814</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="timeLimit"><span class="type-signature"></span>timeLimit<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
时间/人限制，为每个角色SgpPlayerId创建一个时间戳，在指定的时间区间内只能抽一次奖， 否则抛出异常，并且包含timeLimitErrorMsg
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<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#line1820">line 1820</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="timeLimitErrorMsg"><span class="type-signature"></span>timeLimitErrorMsg<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
当用户满足时间/人限制时，抛出的异常中指定的信息
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<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#line1826">line 1826</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="totalLimit"><span class="type-signature"></span>totalLimit<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
次数/人限制，为每个角色创建一个计数器，累计用户的总gacha次数，当小于该次数时不受影响， 否则抛出异常，并且包含totalLimitErrorMsg
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<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#line1832">line 1832</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="totalLimitErrorMsg"><span class="type-signature"></span>totalLimitErrorMsg<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
当用户满足次数/人限制时，抛出的异常中指定的信息
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<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#line1838">line 1838</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :null</span></h4>
</dt>
<dd>
<div class="description">
类型
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">null</span>
</li>
</ul>
<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#line1844">line 1844</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>