-
Notifications
You must be signed in to change notification settings - Fork 0
/
objects_task.js.html
228 lines (194 loc) · 18 KB
/
objects_task.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Source: objects/task.js | Source: objects/task.js</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/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
</head>
<body>
<nav class="lnb" id="lnb">
<div class="logo" style="width: 100px; height: 100px">
<a href="https://github.com/Project-Skill-Tree/Skill-Tree-Discord-Bot" rel="noopener noreferrer" target="_blank">
<img src="https://cdn.discordapp.com/attachments/939508059758288939/979289803239608360/FinalLogoAlt2.png" width="100%" height="100%">
</a>
</div>
<div class="title">
<h1><a href="index.html" class="link">Source: objects/task.js</a></h1>
</div>
<div class="search-container" id="search-container">
<input type="text" placeholder="Search">
<ul></ul>
</div>
<div class="lnb-api hidden"><h3>Modules</h3><ul><li><a href="module-APIHelper.html">APIHelper</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:APIHelper_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-APIHelper.html#.cancel">cancel</a></li><li><a href="module-APIHelper.html#.deleteTask">deleteTask</a></li><li><a href="module-APIHelper.html#.getAllInList">getAllInList</a></li><li><a href="module-APIHelper.html#.getAvailable">getAvailable</a></li><li><a href="module-APIHelper.html#.getCurrentTasks">getCurrentTasks</a></li><li><a href="module-APIHelper.html#.getInProgress">getInProgress</a></li><li><a href="module-APIHelper.html#.getRecentTasks">getRecentTasks</a></li><li><a href="module-APIHelper.html#.revert">revert</a></li><li><a href="module-APIHelper.html#.skip">skip</a></li><li><a href="module-APIHelper.html#.start">start</a></li><li><a href="module-APIHelper.html#.updateTask">updateTask</a></li><li><a href="module-APIHelper.html#~getAPIKey">getAPIKey</a></li></ul></div></li><li><a href="module-badge.html">badge</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:badge_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-badge.html#.drawBadge">drawBadge</a></li><li><a href="module-badge.html#.getBadgeIcon">getBadgeIcon</a></li></ul></div></li><li><a href="module-createSwipePanel.html">createSwipePanel</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:createSwipePanel_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-createSwipePanel.html#.createLargeMultiActionSwipePanel">createLargeMultiActionSwipePanel</a></li><li><a href="module-createSwipePanel.html#.createLargeSwipePanel">createLargeSwipePanel</a></li><li><a href="module-createSwipePanel.html#.createYesNoPanel">createYesNoPanel</a></li></ul></div></li><li><a href="module-frequencyFormatter.html">frequencyFormatter</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:frequencyFormatter_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-frequencyFormatter.html#.dayToDate">dayToDate</a></li><li><a href="module-frequencyFormatter.html#.formatFrequency">formatFrequency</a></li><li><a href="module-frequencyFormatter.html#.getAbsDate">getAbsDate</a></li><li><a href="module-frequencyFormatter.html#.getDaysBetweenDates">getDaysBetweenDates</a></li></ul></div></li><li><a href="module-ProfileRenderer.html">ProfileRenderer</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:ProfileRenderer_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-ProfileRenderer.html#.displayLevelUp">displayLevelUp</a></li><li><a href="module-ProfileRenderer.html#.displayProfile">displayProfile</a></li><li><a href="module-ProfileRenderer.html#.getProfileImage">getProfileImage</a></li><li><a href="module-ProfileRenderer.html#~drawProfile">drawProfile</a></li><li><a href="module-ProfileRenderer.html#~drawProfileInfo">drawProfileInfo</a></li><li><a href="module-ProfileRenderer.html#~drawXP">drawXP</a></li><li><a href="module-ProfileRenderer.html#~getLevelUpProfileImage">getLevelUpProfileImage</a></li></ul></div></li><li><a href="module-romanNumeralHelper.html">romanNumeralHelper</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:romanNumeralHelper_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-romanNumeralHelper.html#.romanise">romanise</a></li></ul></div></li><li><a href="module-UIHelper.html">UIHelper</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:UIHelper_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-UIHelper.html#.addGlow">addGlow</a></li><li><a href="module-UIHelper.html#.codeBlock">codeBlock</a></li><li><a href="module-UIHelper.html#.fillRoundRect">fillRoundRect</a></li><li><a href="module-UIHelper.html#.imageToBuffer">imageToBuffer</a></li><li><a href="module-UIHelper.html#.splitToN">splitToN</a></li><li><a href="module-UIHelper.html#.strokeRoundRect">strokeRoundRect</a></li><li><a href="module-UIHelper.html#.tint">tint</a></li></ul></div></li><li><a href="module-WeeklyReviewRenderer.html">WeeklyReviewRenderer</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:WeeklyReviewRenderer_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-WeeklyReviewRenderer.html#.displayReview">displayReview</a></li><li><a href="module-WeeklyReviewRenderer.html#~drawHeaderFooter">drawHeaderFooter</a></li><li><a href="module-WeeklyReviewRenderer.html#~drawTasks">drawTasks</a></li><li><a href="module-WeeklyReviewRenderer.html#~drawXP">drawXP</a></li><li><a href="module-WeeklyReviewRenderer.html#~getWeeklyReview">getWeeklyReview</a></li></ul></div></li><li><a href="module-XPHandler.html">XPHandler</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:XPHandler_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-XPHandler.html#.calcLevelFromXP">calcLevelFromXP</a></li><li><a href="module-XPHandler.html#.calcXPFromLevel">calcXPFromLevel</a></li><li><a href="module-XPHandler.html#.calcXPToLevelUp">calcXPToLevelUp</a></li><li><a href="module-XPHandler.html#.getCharacter">getCharacter</a></li><li><a href="module-XPHandler.html#.getColor">getColor</a></li><li><a href="module-XPHandler.html#.getRank">getRank</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Classes</h3><ul><li><a href="Challenge.html">Challenge</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Challenge_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Challenge.html#.create">create</a></li><li><a href="Challenge.html#update">update</a></li></ul></div></li><li><a href="Item.html">Item</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Item_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Item.html#.create">create</a></li><li><a href="Item.html#toLine">toLine</a></li><li><a href="Item.html#toString">toString</a></li><li><a href="Item.html#update">update</a></li></ul></div></li><li><a href="ListPage.html">ListPage</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="ListPage_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="ListPage.html#update">update</a></li></ul></div></li><li><a href="Page.html">Page</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Page_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Page.html#update">update</a></li></ul></div></li><li><a href="Rank.html">Rank</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Rank_sub"></div></li><li><a href="Setting.html">Setting</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Setting_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Setting.html#start">start</a></li></ul></div></li><li><a href="Skill.html">Skill</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Skill_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Skill.html#.create">create</a></li><li><a href="Skill.html#update">update</a></li></ul></div></li><li><a href="Task.html">Task</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Task_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Task.html#.create">create</a></li><li><a href="Task.html#isChecked">isChecked</a></li><li><a href="Task.html#percentChecked">percentChecked</a></li><li><a href="Task.html#setChecked">setChecked</a></li></ul></div></li><li><a href="Unlocked.html">Unlocked</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Unlocked_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Unlocked.html#update">update</a></li></ul></div></li><li><a href="User.html">User</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="User_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="User.html#.create">create</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Interfaces</h3><ul><li><a href="Swipeable.html">Swipeable</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Swipeable_sub"></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#addXP">addXP</a></li><li><a href="global.html#authUser">authUser</a></li><li><a href="global.html#createUser">createUser</a></li><li><a href="global.html#deleteUser">deleteUser</a></li><li><a href="global.html#getAPIKey">getAPIKey</a></li><li><a href="global.html#getSettings">getSettings</a></li><li><a href="global.html#getUser">getUser</a></li><li><a href="global.html#getUsers">getUsers</a></li><li><a href="global.html#getUsersInTimezone">getUsersInTimezone</a></li><li><a href="global.html#permlevel">permlevel</a></li><li><a href="global.html#saveProfile">saveProfile</a></li><li><a href="global.html#toProperCase">toProperCase</a></li><li><a href="global.html#updateTimezone">updateTimezone</a></li><li><a href="global.html#updateUser">updateUser</a></li><li><a href="global.html#updateXPHistory">updateXPHistory</a></li></ul></div>
</nav>
<div id="resizer"></div>
<div class="main" id="main">
<section>
<article>
<pre class="prettyprint source linenums"><code>const Skill = require("./skill");
const {getDaysBetweenDates, intervalToInt} = require("../modules/dateHelper");
const Challenge = require("./challenge");
/**
* Task Object
*/
class Task {
/**
* @param id - taskID
* @param child - the child object of this task (skill or challenge)
* @param data - task data
* @param startDate - task start date
* @param completed - T/F if this task has completed
* @constructor
*/
constructor(id, child, data, startDate, completed) {
this.id = id;
this.child = child;
this.data = data;
this.startDate = startDate;
this.completed = completed;
}
/**
* Returns true if this task has been checked off for a given date, false otherwise
* handles dates outside the data range
* @param {Date} date - date to query
* @param tz
* @return {boolean|*}
*/
isChecked(date, tz) {
const index = getDaysBetweenDates(this.startDate, date, tz);
const checked = this.data[index];
return checked ? checked : false;
}
/**
* Sets the task check state for a given day
* handles dates outside the data range
* @param checked - true/false ischecked value to set
* @param {Date} date - date to query
* @param tz
* @return {boolean|*}
*/
setChecked(checked, date, tz) {
const index = Math.abs(getDaysBetweenDates(this.startDate, date, tz));
this.data[index] = checked;
//Write all nonexistant data as false
for (let i = 0; i < this.data.length; i++) {
if (this.data[i] === undefined || this.data[i] === null) {
this.data[i] = false;
}
}
}
/**
* Returns the percentage of times this task has been checked off
* between the task start date and the current date
* @return {string}
*/
percentChecked(date, tz) {
//Set current value in case there was a long gap between tasks
//Data only stores the most recent set, so we need to set the current date to
//the value at isChecked true if true, false if false, and false if not found.
//That sets the length to the correct value to calculate the percentage
this.setChecked(this.isChecked(date, tz), date, tz);
let data;
if (this.child instanceof Skill) {
data = [...this.data];
const blockSize = intervalToInt(this.child.interval);
//If the interval is N/A, take all the data
if (blockSize !== -1) {
//take only the data within the current interval
const newIndexOfStart = Math.floor((data.length - this.child.timelimit) / blockSize) * blockSize;
const limitSize = data.length - newIndexOfStart;
data = data.slice(-limitSize);
}
} else { //challenge has no time limit
data = this.data;
}
//return percentage as a string
return `${Math.round(100 * data.filter(Boolean).length / data.length)}%`;
}
numCheckedInInterval(date, tz) {
//Set current value in case there was a long gap between tasks
//Data only stores the most recent set, so we need to set the current date to
//the value at isChecked true if true, false if false, and false if not found.
//That sets the length to the correct value to calculate the percentage
this.setChecked(this.isChecked(date, tz), date, tz);
let data;
const interval = intervalToInt(this.child.interval);
const frequency = this.child.frequency;
if (this.child instanceof Skill) {
data = [...this.data]; //only check the last <timelimit> days
if (interval !== -1) {
const curIntervalLength = (this.data.length - Math.floor(this.data.length / interval) * interval) + 1;
data = data.slice(Math.min(-curIntervalLength,-1));
}
} else { //challenge has no time limit
data = this.data;
}
return `${data.filter(Boolean).length}/${frequency}`;
}
daysLeftInterval(date, tz) {
//Set current value in case there was a long gap between tasks
//Data only stores the most recent set, so we need to set the current date to
//the value at isChecked true if true, false if false, and false if not found.
//That sets the length to the correct value to calculate the percentage
this.setChecked(this.isChecked(date, tz), date, tz);
//Split goals into equal sections covering the time limit for the given frequency
const blockSize = intervalToInt(this.child.interval);
const timelimit = this.child.timelimit;
let daysLeft;
if (blockSize !== -1) {
daysLeft = Math.max(timelimit - this.data.length, 0);
} else {
daysLeft = "N/A";
}
if (daysLeft === 0) {
return "ongoing";
} else {
return `${daysLeft} day(s) left`;
}
}
/**
* Create Task object from json data
* @param data - JSON data for the task
* @return {Task}
*/
static create(data) {
let child;
if (data.skillID) {
child = Skill.create(data.skillID);
} else {
child = Challenge.create(data.challengeID);
}
return new Task(data._id, child, data.data, new Date(data.startDate), data.completed);
}
}
module.exports = Task;
</code></pre>
</article>
</section>
</div>
<footer>
<img class="logo" src="https://cdn.discordapp.com/attachments/939508059758288939/979289803239608360/FinalLogoAlt2.png" style="width: 100px; height: 100px">
<div class="footer-text">NHN Entertainment. Frontend Development Lab</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>
<script>
var id = '_sub'.replace(/"/g, '_');
var selectedApi = document.getElementById(id); // do not use jquery selector
var $selectedApi = $(selectedApi);
$selectedApi.removeClass('hidden');
$selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
showLnbApi();
</script>
</body>
</html>