-
Notifications
You must be signed in to change notification settings - Fork 0
/
coinToss.js
235 lines (178 loc) · 6.71 KB
/
coinToss.js
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
229
230
231
232
233
234
235
/**
* This widget visualizes the outcome of a random distribution (e.g. coin toss).
* To achieve this, it uses multiple video pools (one per possible outcome) from
* which a random video is picked.
*
* Special thanks to Benno and Reboot0.
*/
/* Prefixes defined in 'Fields' are only taken into account if they are also
* specified in this list. */
const outcomePrefixes = [
"outcome1",
"outcome2"
];
let allowed = false; // Blocks the widget when busy.
const videoPools = []; // Holds the diffent video pools.
let commandStr;
let cooldownMillis;
let cooldownEndEpoch = 0;
let isUsableByEveryone; // If true, everyone can trigger the widget.
let isUsableByMods;
let otherUsers; // Those users can trigger the widget, too.
/* Triggers CSS animations by adding animate.css classes. Their effect is
* sustained as long as they're attached to the element. Therefore, they are
* only removed to immediately replace them with other animate.css classes. */
function animateCss(node, animationName, duration = 1, prefix = 'animate__') {
// animate.css classes do have a prefix (since version 4.0).
const envCls = `${prefix}animated`;
const animationCls = `${prefix}${animationName}`;
// Remove all applied animate.css classes.
node.className = node.className
.split(" ")
.filter((cls) => !cls.startsWith(prefix))
.join(" ");
// Promise resolves when animation has ended.
return new Promise((resolve, reject) => {
node.addEventListener('animationend', (event) => {
event.stopPropagation();
resolve('Animation ended');
}, {once: true});
node.style.setProperty('--animate-duration', `${duration}s`);
node.classList.add(envCls, animationCls); // Starts CSS animation.
});
}
// Returns a random element of the array.
function randomItemFromArray(arr) {
return arr[Math.floor(Math.random() * arr.length)];
}
// Uses the input of a media field to test whether media was added to it.
function isMediaFieldPopulated(input) {
return (input && (Array.isArray(input) ? (input.length > 0) : true));
}
/* Sets a (global) cooldown. To avoid unnecessary calculations, it is represented
* by an epoch time that marks the moment, when the cooldown has ended. Later code
* then simply compares this to the current epoch time. */
function activateCooldown() {
cooldownEndEpoch = Date.now() + cooldownMillis;
}
function isOnCooldown() {
return (Date.now() < cooldownEndEpoch);
}
// Represents the video pool for a possible outcome.
class VideoPool {
static videoElmt = document.getElementById("video");
#url;
normalizedVolume;
static {
// Hide video element immediately (therefore, 0s duration).
const hideVideoElmt =
() => animateCss(VideoPool.videoElmt, "{{animationOut}}", 0);
// Ensures a defined initial state.
hideVideoElmt();
// When a video playback starts, trigger the in-animation.
VideoPool.videoElmt.onplay =
() => animateCss(VideoPool.videoElmt, "{{animationIn}}", {{timeIn}});
// When an error occurs, unblock the widget.
VideoPool.videoElmt.onerror = () => {
hideVideoElmt(); // Otherwise the next in-animation would be skipped.
allowed = true;
throw VideoPool.videoElmt.error;
};
// When a video ends, trigger the out-animation.
VideoPool.videoElmt.onended = async () => {
try {
await animateCss(VideoPool.videoElmt, "{{animationOut}}", {{timeOut}});
} finally {
/* Unblock the widget only after the out-animation has finished. Otherwise
* there would be a chance that it's interrupted. */
allowed = true;
}
};
}
constructor(url, volumePct) {
this.#url = url;
this.normalizedVolume = volumePct / 100;
}
/* If an array of media is provided, a random element is picked. (That's the
* case when the field's "multiple" parameter is true.) */
get url() {
if (Array.isArray(this.#url)) {
return randomItemFromArray(this.#url);
}
return this.#url;
}
set url(newUrl) {
this.#url = newUrl;
}
async play() {
VideoPool.videoElmt.pause();
VideoPool.videoElmt.src = this.url; // Getter returns a random video.
VideoPool.videoElmt.volume = this.normalizedVolume;
// 'load() will reset the element and rescan the available sources ...'
VideoPool.videoElmt.load();
allowed = false;
VideoPool.videoElmt.play();
activateCooldown();
}
}
function onWidgetLoad(obj) {
const fieldData = obj.detail.fieldData;
// Makes it easier for the user to look up the widget version.
console.log(`Initialize ${fieldData.widgetName} (v${fieldData.widgetVersion}).`);
// Case-insensitivity is achieved by converting all strings to lowercase.
commandStr = fieldData.command.toLowerCase();
// If no trigger phrase was specified, the widget should remain blocked.
if (commandStr !== "") {
console.log(`Associated command: ${commandStr}`);
} else {
console.log("Deactivate widget: empty command");
return;
}
isUsableByEveryone = (fieldData.permissionLvl === "everyone");
isUsableByMods = (fieldData.permissionLvl === "mods");
otherUsers = fieldData.otherUsers
.toLowerCase()
.replace(/\s/g, '')
.split(",");
cooldownMillis = fieldData.cooldown * 1000;
// Initialize VideoPools.
for (const prefix of outcomePrefixes) {
//console.log(`Initialize prefix '${prefix}'`);
let url = fieldData[`${prefix}_url`];
if (!isMediaFieldPopulated(url)) {
console.log(
"Deactivate widget: at least one outcome has no associated videos.");
return;
}
videoPools.push(
new VideoPool(url, fieldData[`${prefix}_volume`]));
}
// Unblock the widget when successfully initialized.
allowed = true;
}
function onMessage(msg) {
if (!allowed) {
//console.log("Widget is currently blocked.");
return;
}
if (isOnCooldown()) {
//console.log("Cooldown is still running.");
return;
}
// Check if the user has enough permissions for the selected mode.
if (isUsableByEveryone ||
(isUsableByMods && msg.isModerator()) ||
msg.isBroadcaster() ||
msg.usernameOnList(otherUsers)) {
if (commandStr !== msg.text.toLowerCase()) {
return;
}
//console.log(`'${commandStr}' has been detected.`);
/* Picks a random video pool. The pool object itself plays then a random video.
* This should guarantee that the number of videos in each pool doesn't affect
* the probability. */
randomItemFromArray(videoPools).play();
} /*else {
console.log(`'${msg.username}' has insufficient permissions.`);
}*/
}