// Copyright 2018-2019 Campbell Crowley. All rights reserved.
// Author: Campbell Crowley (dev@campbellcrowley.com)
require('./subModule.js').extend(Uno); // Extends the SubModule class.
/**
* @classdesc Manages an Uno game.
* @class
* @augments SubModule
* @listens Command#uno
*/
function Uno() {
const self = this;
/** @inheritdoc */
this.myName = 'Uno';
/** @inheritdoc */
this.initialize = function() {
pFlags = self.Discord.Permissions.FLAGS;
self.command.on(
new self.command.SingleCommand(
['uno', 'one'], commandUno, {validOnlyInGuild: true}, [
new self.command.SingleCommand('endall', commandEndAll, {
validOnlyInGuild: true,
permissions: pFlags.MANAGE_CHANNELS,
defaultDisabled: true,
}),
new self.command.SingleCommand('stats', commandStats),
]));
};
/** @inheritdoc */
this.shutdown = function() {
self.command.removeListener('uno');
const list = Object.values(games);
list.forEach((el) => {
const list = Object.values(el);
list.forEach((el) => {
if (typeof el.end === 'function') el.end();
});
});
};
/** @inheritdoc */
this.unloadable = function() {
return numGames <= 0;
};
/**
* ASCII art text to show when a player calls Uno.
*
* @private
* @constant
* @default
* @type {string}
*/
const unoText = '888 888 888b 888 .d88888b. 888 \n' +
'888 888 8888b 888 d88P" "Y88b 888 \n' +
'888 888 88888b 888 888 888 888 \n' +
'888 888 888Y88b 888 888 888 888 \n' +
'888 888 888 Y88b888 888 888 888 \n' +
'888 888 888 Y88888 888 888 Y8P \n' +
'Y88b. .d88P 888 Y8888 Y88b. .d88P " \n' +
' "Y88888P" 888 Y888 "Y88888P" 888 ';
/**
* The number of currently active games. Used to determine of submodule is
* unloadable.
*
* @private
* @type {number}
* @default
*/
let numGames = 0;
/**
* Self.Discord.Permissions.FLAGS.
*
* @private
*/
let pFlags = null;
/**
* All games currently in progress mapped by guilds, then by the game ID.
*
* @private
* @type {object.<object.<Uno.Game>>}
*/
const games = {};
/**
* Delay for NPC to play their card.
*
* @private
* @type {number}
* @default
* @constant
*/
const npcDelay = 5000;
/* eslint-disable no-multi-spaces */
/**
* Default names of NPCs to add when adding non-bot NPCs.
*
* @private
* @default
* @constant
* @type {string[]}
*/
const npcNames = [
'HAL', 'Jane', 'HEX', 'Deep Thought', 'Com Pewter',
'EDI', 'JARVIS', 'Samantha', 'TARS', 'Ava',
'Friday', 'Legion', 'Cortana', 'GLaDOS', 'Guilty Spark',
'2B', '9S', 'CL4P-TP', 'Computer', 'NPC',
'AI', 'Bot', 'CPU', 'R2D2', 'AUTO',
'CASE', 'Alexa', 'Bixby',
];
/* eslint-enable */
/**
* Maximum number of players allowed in a game.
*
* @private
* @type {number}
* @default
* @constant
*/
const maxPlayerCount = 10;
/**
* Starts an Uno game. If someone is mentioned it will start a game
* between the message author and the mentioned person. Otherwise, waits for
* someone to play.
*
* @private
* @type {commandHandler}
* @param {Discord~Message} msg Message that triggered command.
* @listens Command#uno
*/
function commandUno(msg) {
if (!msg.guild.me.hasPermission(pFlags.MANAGE_CHANNELS)) {
self.common.reply(
msg,
'I need permission to manage channels in order to start a game of ' +
'UNO.');
return;
}
if (games[msg.guild.id]) {
const entries = Object.values(games[msg.guild.id]);
const g = entries.find((el) => el.getPlayers().includes(msg.author.id));
if (g) {
if (g.groupChannel.id == msg.channel.id) {
return;
}
self.common.reply(
msg, 'You appear to already be in a game. ' +
'You may only be in one game at a time.');
return;
}
}
self.common.reply(
msg, 'Creating a game of UNO.',
'Please be aware, Uno is still in BETA and has many known bugs.');
if (!games[msg.guild.id]) games[msg.guild.id] = {};
const newGame = new self.Game(
(msg.mentions.members.array() || []).concat([msg.member]), msg.member);
games[msg.guild.id][newGame.id] = newGame;
}
/**
* Ends all Uno games.
*
* @private
* @type {commandHandler}
* @param {Discord~Message} msg Message that triggered command.
* @listens Command#uno_endall
*/
function commandEndAll(msg) {
if (!msg.guild.me.hasPermission(pFlags.MANAGE_CHANNELS)) {
self.common.reply(msg, 'I don\'t have permission to manage channels.');
return;
}
if (!games[msg.guild.id]) {
self.common.reply(
msg, 'There are no UNO games in progress in this server.');
return;
}
const list = Object.values(games[msg.guild.id]);
list.forEach((g) => {
if (typeof g.end == 'function') g.end();
});
delete games[msg.guild.id];
self.common.reply(msg, 'All UNO games have been ended.').catch(() => {});
}
/**
* Sends information about current uno games.
*
* @private
* @type {commandHandler}
* @param {Discord~Message} msg Message that triggered command.
* @listens Command#uno_stats
*/
function commandStats(msg) {
if (msg.author.id == self.common.spikeyId && numGames > 0) {
let lastInteractTimestamp = 0;
let lastCreatedTimestamp = 0;
const list = Object.values(games);
list.forEach((el) => {
const list = Object.values(el);
list.forEach((el) => {
lastInteractTimestamp =
Math.max(el.lastInteractTimestamp, lastInteractTimestamp);
lastCreatedTimestamp =
Math.max(el.createTimestamp, lastCreatedTimestamp);
});
});
self.common.reply(
msg, 'There are currently ' + numGames + ' games.',
'Last Interaction: ' +
Math.round((Date.now() - lastInteractTimestamp) / 60000) +
'm\nLast Created: ' +
Math.round((Date.now() - lastCreatedTimestamp) / 60000) + 'm');
} else {
self.common.reply(msg, 'There are currently ' + numGames + ' games.');
}
}
/**
* Enum for card colors.
*
* @public
* @constant
* @default
* @enum {number}
*/
this.Color = {
NONE: 0,
RED: 1,
BLUE: 2,
GREEN: 3,
YELLOW: 4,
};
/**
* Color as entries.
*
* @private
* @constant
*/
const colorPairs = Object.entries(self.Color);
/**
* Regular expression search for acceptable colors. Case insensitive and
* global flags are set.
*
* @private
* @constant
* @type {RegExp}
*/
const colorRegExp = new RegExp(colorPairs.map((el) => el[0]).join('|'), 'ig');
/**
* Enum for card faces. The two least significant nibbles are the card face.
* The most significant used nibbles are for card effects (designated by the
* `EFFECT_MASK`).
*
* BASE_MASK is the bitwise not of EFFECT_MASK, except on only the nibbles
* that are less significant than EFFECT_MASK.
*
* 0x01000: The card is a wild card.
* 0x02000: The card skips the next player's turn.
* 0x04000: The card reverses play direction.
* 0x08000: The card causes the next player after the turn is over, to draw 2
* cards.
* 0x10000: The next player must draw 4 cards.
*
* EFFECT entries are NOT real card faces, just the bitfield represented with
* that effect.
*
* @public
* @constant
* @enum {number}
*/
this.CardFace = {
// Card Face Effects Bases
EFFECT_MASK: 0xFF000,
BASE_MASK: 0x00FFF,
WILD_EFFECT: 0x01000,
SKIP_EFFECT: 0x02000,
REVERSE_EFFECT: 0x04000,
DRAW_TWO_EFFECT: 0x08000,
DRAW_FOUR_EFFECT: 0x10000,
// Card Faces
SKIP: 0x02010,
DRAW_TWO: 0x0A020,
DRAW_2: 0x0A020,
REVERSE: 0x04030,
WILD: 0x01040,
DRAW_FOUR: 0x13050,
DRAW_4: 0x13050,
ZERO: 0x0, 0: 0x0,
ONE: 0x1, 1: 0x1,
TWO: 0x2, 2: 0x2,
THREE: 0x3, 3: 0x3,
FOUR: 0x4, 4: 0x4,
FIVE: 0x5, 5: 0x5,
SIX: 0x6, 6: 0x6,
SEVEN: 0x7, 7: 0x7,
EIGHT: 0x8, 8: 0x8,
NINE: 0x9, 9: 0x9,
};
/**
* CardFace as entries.
*
* @private
*/
const cardFacePairs = Object.entries(self.CardFace).filter((el) => {
return !el[0].endsWith('_EFFECT') && !el[0].endsWith('_MASK');
});
/**
* Regular expression search for acceptable card faces. Case insensitive and
* global flags are set.
*
* @private
* @constant
* @type {RegExp}
*/
const cardFaceRegExp = new RegExp(
cardFacePairs.map((el) => el[0].replace(/_/g, ' ')).join('|'), 'ig');
/**
* Class that stores the current information about a particular card. All
* cards with the same color and face value are represented here using the
* `count` attribute.
*
* @class
*
* @public
* @param {CardFace} face The face value or type of card this is.
* @param {Color} color The color of this card.
*/
this.Card = function(face, color) {
if (typeof face !== 'number') {
throw new Error('Given value for card face is not a number!');
}
const card = this;
/**
* The face value of this card.
*
* @public
* @type {Uno.CardFace}
*/
this.face = face;
if (typeof color !== 'number') {
throw new Error('Given value for card color is not a number!');
}
/**
* The color of this card.
*
* @public
* @type {Uno.Color}
*/
this.color = color;
/**
* The name of this card retreivable with `toString()`. Null until first
* `toString()` call.
*
* @private
* @type {?string}
*/
let myName;
/**
* Stringifies the face and colors to their key names.
*
* @public
*
* @returns {string} This card as a string.
*/
this.toString = function() {
// Wild cards can change color, so we can't cache their name.
if (myName && !(card.face & self.CardFace.WILD_EFFECT)) return myName;
const face =
formatCard(cardFacePairs.find((el) => el[1] == card.face)[0]);
if (card.color == self.Color.NONE) {
myName = face;
} else {
let colorName = colorPairs.find((el) => el[1] == card.color);
if (!colorName) {
self.error('Unable to format card to string.');
console.log(card);
console.log(card.color, 'not a valid color');
colorName = colorPairs.find((el) => el[0] == card.color);
if (colorName) {
card.color = colorName[1];
}
}
colorName = formatCard(colorName[0]);
myName = colorName + ' ' + face;
}
return myName;
};
};
/**
* Class that stores the current state of an Uno game.
*
* @class
*
* @public
* @param {Discord~GuildMember[]} memberList The players to initially add to
* this game.
* @param {Discord~GuildMember} maker The player who created the game and can
* change settings and manage users.
*/
this.Game = function(memberList, maker) {
const game = this;
numGames++;
if (!memberList || !memberList.length) {
throw new Error('Member list must be an array of Discord.GuildMembers.');
}
if (!maker || !maker.guild) {
throw new Error('Game maker must be a guild member.');
}
/**
* The guild members in this game mapped by their ID.
*
* @private
* @type {object.<Discord~GuildMember>}
*/
const members = {};
do {
/**
* The ID of this uno game. Should be unique per guild.
*
* @public
* @readonly
* @type {number}
*/
this.id = Math.floor((Math.random() * 1000));
} while (games[maker.guild.id][game.id]);
/**
* The array of all player in the game in the order of their turn.
*
* @private
* @type {Array.<Uno.Player|Uno.NPC>}
*/
const players = [];
/**
* The category that stores all channels for this game. Null until it is
* created.
*
* @public
* @type {?Discord~CategoryChannel}
*/
this.catChannel = null;
/**
* The channel that all players of this game can view and type in. Null
* until the channel is created.
*
* @public
* @type {?Discord~TextChannel}
*/
this.groupChannel = null;
/**
* All cards currently not in a player's hand.
*
* @private
* @type {Uno.Card[]}
*/
let discarded = self.getHand();
/**
* Has this game been started.
*
* @public
* @default
* @readonly
* @type {boolean}
*/
this.started = false;
/**
* The timestamp at which this game was first created.
*
* @public
* @readonly
* @constant
* @type {number}
*/
this.createTimestamp = Date.now();
/**
* The timestamp at which this game was last interacted with.
*
* @public
* @readonly
* @constant
* @type {number}
*/
this.lastInteractTimestamp = Date.now();
/**
* The current index of the player whose turn it is.
*
* @private
* @default
* @type {number}
*/
let turn = -1;
/**
* If we need to wait for the player to choose a color for a wild card.
* `null` if not waiting, or a reference to the player we are waiting for.
*
* @private
* @default
* @type {Uno.Player}
*/
// let waitingForColor = -1;
/**
* The current number of cards a player will need to draw if they cannot
* stack another draw card.
*
* @private
* @type {number}
*/
// let drawCount = 0;
/**
* The card played by the previous player in the turn order. Will be null
* after a player has been skipped, since they did not play a card.
*
* @see {@link Uno.Game~topCard}
*
* @private
* @type {?Uno.Card}
*/
// let previousCard = null;
/**
* The index of the player whose turn it was previously. This is -1 if the
* current turn is the first turn of the game, and will otherwise be the
* previous player to play a card.
*
* @private
* @type {number}
*/
let previousTurn = -1;
/**
* The current card on the top of the discard pile that will need to be
* matched by the next player to play a card.
*
* @see {@link Uno.Game~previousCard}
*
* @private
* @type {?Uno.Card}
*/
let topCard = null;
/**
* The current direction of play. Either 1 or -1.
*
* @private
* @default
* @type {number}
*/
let direction = 1;
/**
* The current Discord~MessageCollector that is listening to messages in the
* groupChannel.
*
* @private
* @default
* type {?Discord~MessageCollector}
*/
let currentCollector = null;
/**
* Creates all channels for this game and currently added players.
*
* @private
*/
(function setupChannels() {
const channelOpts = {
topic: 'UNO! (ID:' + game.id + ')',
type: 'category',
reason: 'An UNO game was started by ' + maker.user.tag,
};
const groupPerms = [
{
id: maker.guild.roles.everyone,
allow: 0,
deny: pFlags.VIEW_CHANNEL | pFlags.SEND_MESSAGES,
type: 'role',
},
{
id: self.client.user.id,
allow: pFlags.VIEW_CHANNEL | pFlags.SEND_MESSAGES,
deny: 0,
type: 'member',
},
];
for (let i = 0; i < memberList.length; i++) {
members[memberList[i].id] = memberList[i];
groupPerms.push({
id: memberList[i].id,
allow: pFlags.VIEW_CHANNEL | pFlags.SEND_MESSAGES,
deny: 0,
type: 'member',
});
}
maker.guild.channels.create('uno-' + game.id, channelOpts).then((c) => {
game.catChannel = c;
maker.guild.channels
.create('uno-' + game.id, {
topic: 'UNO! (ID:' + game.id + ')',
type: 'text',
reason: 'An UNO game was started by ' + maker.user.tag,
permissionOverwrites: groupPerms,
parent: c,
})
.then((c) => {
game.groupChannel = c;
let fail = false;
for (let i = 0; i < memberList.length && !fail; i++) {
fail = fail || !game.addPlayer(memberList[i]);
}
if (memberList.length > maxPlayerCount) {
setTimeout(function() {
c.send(
'A maximum of ' + maxPlayerCount +
' players are allowed');
}, 1000);
}
finishSetup();
});
});
})();
/**
* Begins listening for messages in the groupChannel that relate to the
* setup of the game, and sends a message to the group channel with game
* instructions.
*
* @private
*/
function finishSetup() {
sendHelp().then(() => {
// This is disabled during testing as to not annoy others with
// random notifications.
/* game.groupChannel.permissionOverwrites
.resolve(maker.guild.roles.everyone)
.update({VIEW_CHANNEL: true}); */
});
if (currentCollector) {
currentCollector.stop(
'Previous collector failed to end before setup finish.');
// This is normal after a bot wins the game since it does not properly
// end the previous collector.
}
currentCollector = game.groupChannel.createMessageCollector((m) => {
const prefix = self.bot.getPrefix(m.guild);
if (m.content.startsWith(prefix)) {
m.content = m.content.replace(prefix, '');
}
if (m.author.id != maker.id) {
if (m.content.toLowerCase().startsWith('uno leave')) {
// self.debug(m.channel.id + '@' + m.author.id + ' ' + m.content);
game.removePlayer(m.author.id);
}
return false;
}
if (m.content.toLowerCase().startsWith('uno')) {
const split = m.content.toLowerCase().split(' ');
game.lastInteractTimestamp = Date.now();
// self.debug(m.channel.id + '@' + m.author.id + ' ' + m.content);
const cmd = split[1];
switch (cmd) {
case 'begin':
case 'start':
if (players.length > 1) {
setTimeout(startGame);
return true;
} else {
self.common.reply(
m,
'You can\'t play by yourself! `invite` other players to' +
' join you first.');
return false;
}
case 'end':
case 'abort':
case 'stop':
game.end();
return true;
case 'players':
case 'list':
listPlayers();
return false;
case 'invite':
if (m.mentions.members.size == 0) {
self.common.reply(m, 'Please mention users to invite.');
} else {
let fail = false;
m.mentions.members.forEach((m) => {
fail = fail || !game.addPlayer(m);
});
if (fail) {
self.common.reply(
m, 'There is a limit of ' + maxPlayerCount + ' players.');
} else {
self.common.reply(m, 'Players have been added to the game.');
}
}
return false;
case 'npc':
case 'ai':
case 'bot': {
const subCmd = split[2];
switch (subCmd) {
case 'add': {
const num = split[3];
if (isNaN(num)) {
self.common.reply(
m, 'Please specify how many NPCs to add.');
} else {
const fail = game.addNPCs(num);
if (!fail) {
self.common.reply(
m, 'There is a maximum of ' + maxPlayerCount +
' players allowed.');
} else {
self.common.reply(m, 'Added NPCs.');
}
}
return false;
}
case 'remove': {
const num = split[3];
if (isNaN(num)) {
self.common.reply(
m, 'Please specify how many NPCs to remove.');
} else {
game.removeNPCs(num);
self.common.reply(m, 'Removed NPCs.');
}
return false;
}
}
break;
}
case 'kick': {
let bad = false;
m.mentions.members.forEach((el) => {
if (el.id != maker.id) game.removePlayer(el);
else bad = true;
});
if (bad) {
self.common.reply(
m, 'As the game creator you cannot leave the game.\nIf' +
' you wish to end the game, use `uno end`.');
}
listPlayers();
return false;
}
case 'leave':
self.common.reply(
m, 'As the game creator you cannot leave the game.\nIf' +
' you wish to end the game, use `uno end`.');
return false;
}
return false;
}
}, {max: 1});
currentCollector.on('end', () => {
currentCollector = null;
});
}
/**
* Send the list of current players in this game to the group channel.
*/
function listPlayers() {
const embed = new self.Discord.MessageEmbed();
embed.setTitle('Current Players');
embed.setDescription(players.map((p) => p.name).join(', '));
embed.setColor('WHITE');
game.groupChannel.send(embed);
}
/**
* Deal cards to all players, and start the game.
*
* @private
*/
function startGame() {
game.groupChannel.updateOverwrite(
maker.guild.roles.everyone, {
VIEW_CHANNEL: false,
},
'UNO game has starte.');
for (turn = 0; turn < players.length; turn++) {
players[turn].hand = [];
drawCards(7, true);
}
game.groupChannel.send('`Cards have been dealt.`');
turn = -1;
game.started = true;
// Play the game's first card.
playCard();
if (currentCollector) {
currentCollector.stop(
'Previous collector failed to end before game start.');
self.warn('Ending previous collector that should not exist.');
}
currentCollector = game.groupChannel.createMessageCollector((m) => {
const prefix = self.bot.getPrefix(m.guild);
if (m.content.startsWith(prefix)) {
m.content = m.content.replace(prefix, '');
}
// Check for Uno calls.
if (m.content.match(/^uno\W*$/i)) {
game.lastInteractTimestamp = Date.now();
callUno(m.author.id);
return false;
}
if (m.author.id == maker.id &&
m.content.toLowerCase().startsWith('uno')) {
game.lastInteractTimestamp = Date.now();
// self.debug(m.channel.id + '@' + m.author.id + ' ' + m.content);
switch (m.content.toLowerCase().split(' ')[1]) {
case 'end':
game.end();
return true;
case 'kick': {
let bad = false;
m.mentions.members.forEach((el) => {
if (el.id != maker.id) game.removePlayer(el);
else bad = true;
});
if (bad) {
self.common.reply(
m, 'As the game creator you cannot leave the game.\nIf' +
' you wish to end the game, use `uno end`.');
}
listPlayers();
return false;
}
}
}
if (turn < 0 || !players[turn] || m.author.id != players[turn].id) {
return false;
}
if (m.content.toLowerCase().startsWith('uno')) {
game.lastInteractTimestamp = Date.now();
// self.debug(m.channel.id + '@' + m.author.id + ' ' + m.content);
const cmd = m.content.toLowerCase().split(' ')[1];
switch (cmd) {
case 'play':
if (playCard(m.content.split(' ').slice(2).join(' '))) {
endGame();
return true;
} else {
return false;
}
case 'leave':
game.removePlayer(m.author.id);
return false;
}
return false;
} else if (m.content.toLowerCase().startsWith('play')) {
game.lastInteractTimestamp = Date.now();
// self.debug(m.channel.id + '@' + m.author.id + ' ' + m.content);
if (playCard(m.content.split(' ').slice(1).join(' '))) {
endGame();
return true;
} else {
return false;
}
} else if (m.content.toLowerCase().startsWith('draw')) {
game.lastInteractTimestamp = Date.now();
// self.debug(m.channel.id + '@' + m.author.id + ' ' + m.content);
drawAndSkip();
game.groupChannel.send(getCardEmbed(topCard));
return false;
}
}, {max: 1});
currentCollector.on('end', () => {
currentCollector = null;
});
}
/**
* Called after a game has been won by somebody. Clears all players of their
* cards, and resets the game to ready for next game state.
*
* @private
*/
function endGame() {
setTimeout(finishSetup, 5000);
game.started = false;
turn = -1;
players.forEach((p) => {
discarded = discarded.concat(p.hand.splice(0));
});
}
/**
* @description Sends the game help to the group channel.
*
* @private
* @returns {Promise.<Discord~Message>} Promise of command help being sent
* to the channel.
*/
function sendHelp() {
const embed = new self.Discord.MessageEmbed();
embed.setTitle('Welcome to UNO! (Beta)');
embed.setAuthor(maker.user.tag);
embed.setColor([237, 21, 31]);
embed.setDescription(
'Just type `UNO!` into this channel to call uno.\nTo play a card, ' +
'just type `play red 4` or `play yellow two` or `play draw 4` or ' +
'something like that.\nIf you play a wild card, you must say what ' +
'color it is when you play it (eg: `play wild red` or `play yellow ' +
'draw four`).\n`draw` to draw a card.');
embed.addField(
'Current Rules',
'Original rules (non-point based) as described here: ' +
'https://www.unorules.com/\nWith the following exceptions:\n' +
'1) Challenging a plus four card is not in this version,\n' +
'2) If you draw a card, you do not get to play it until your ' +
'next turn.');
embed.addField(
'Player Commands',
'If you do not wish to be in this game anymore, just type ' +
'`uno leave` in this channel, and you will be removed.');
if (!game.started) {
embed.addField(
'Lobby Settings',
'The creator of this game can use the following commands in this ' +
'channel.\n\nUse `invite @SpikeyRobot#0001` to add new people' +
' to this game.\nUse `uno npc add 2` to add 2 NPCs or `uno ' +
'npc remove 3` to remove 3 NPCs.\nType `uno kick ' +
'@SpikeyRobot#0001` to remove them from the game (Note: ' +
'don\'t use the command prefix).\nType `uno start` to start ' +
'the game once you\'re ready!\n`uno end` to end this game at ' +
'any time.');
} else {
embed.addField(
'Lobby Settings',
'The creator of this game can use the following commands in this ' +
'channel.\n\n`uno end` to end this game at any time (this ' +
'deletes all Uno text channels).\n`uno kick @SpikeyRobot#0001' +
'` to kick players (Careful! They cannot be added back during' +
' the game!).');
}
return game.groupChannel.send(embed);
}
/**
* Called after a player's turn, to trigger the next player's turn.
*
* @param {boolean} [skip=false] True to add additional message saying this
* player is skipped. Also doesn't send the player their hand. True if this
* turn is intended to be skipped.
* @private
*/
function nextTurn(skip) {
if (turn > -1 && players[turn] && !players[turn].npc) {
players[turn].channel.send(
'`Your current hand:`', getCardEmbed(players[turn].hand));
}
if (turn == -1) turn = Math.floor(Math.random() * players.length);
turn += direction;
if (turn < 0) turn = players.length - 1;
if (turn > players.length - 1) turn = 0;
if (!players[turn]) {
game.groupChannel.send(
'Game Crashed. Unable to keep track of players properly.' +
' Please report this bug.');
endGame();
return;
}
if (skip) {
game.groupChannel.send(
'`Skipping` ' + players[turn].mention + '\'s turn!');
} else {
game.groupChannel.send(
'`Next turn.` ' + players[turn].mention + '\'s turn! They have ' +
players[turn].hand.length + ' cards.');
if (players[turn].npc) setTimeout(playCard, npcDelay);
}
}
/**
* Cause the current player to draw cards from the discarded pile, then skip
* their turn and continue to the next player.
*
* @private
* @param {number} [num=1] The number of cards to draw.
*/
function drawAndSkip(num = 1) {
drawCards(num);
// previousCard = null;
nextTurn();
}
/**
* Cause the current player to draw cards from the discarded pile.
*
* @private
* @param {number} num The number of cards to draw.
* @param {boolean} [silent=false] Do not send a message to the group
* channel.
*/
function drawCards(num, silent = false) {
const drawn = [];
for (let j = 0; j < num; j++) {
if (discarded.length == 0) break;
const single = discarded.splice(
Math.floor(Math.random() * discarded.length), 1)[0];
if (single.face & self.CardFace.WILD_EFFECT) {
single.color = self.Color.NONE;
}
drawn.push(single);
}
players[turn].hand = drawn.concat(players[turn].hand);
if (!players[turn].npc) {
players[turn].hand = players[turn].hand.sort((a, b) => {
if (a.face == b.face) {
return a.color - b.color;
} else {
return a.face - b.face;
}
});
}
if (!silent) {
game.groupChannel.send(
'`' + players[turn].name + '` drew ' + num + ' card' +
(num == 1 ? '' : 's') + ' from the deck.');
if (!players[turn].npc) {
players[turn].channel.send(
'`You drew:` ' + drawn.map((card) => card.toString()).join(', '));
}
} else {
if (!players[turn].npc) {
players[turn].channel.send(
'`Your current hand`', getCardEmbed(players[turn].hand));
}
}
players[turn].calledUno = false;
}
/**
* Play a card for the current player.
*
* @private
* @param {?string} text User inputted text to parse into a card to play.
* @returns {boolean} True if the game has ended. False if the game should
* continue.
*/
function playCard(text) {
let selected = -1;
let hand;
let color; // Used if a wild card was played.
if (turn == -1) {
// First card to be played. No restrictions, any card can be played.
selected = Math.floor(Math.random() * discarded.length);
hand = discarded;
if (hand[selected].face & self.CardFace.WILD_EFFECT) {
color =
colorPairs[Math.floor(Math.random() * (colorPairs.length - 1)) +
1][1];
}
} else {
hand = players[turn].hand;
if (players[turn].npc) {
if (previousTurn > -1 && !players[previousTurn].calledUno &&
players[previousTurn].hand.length == 1 &&
Math.random() < players[turn].probCallUno) {
callUno(players[turn].id);
setTimeout(function() {
playCard(text);
}, npcDelay);
return;
}
let i = hand.length;
// Cards are in order of how they were drawn from the deck. This
// prioritizes the oldest cards first.
do {
selected = --i;
} while (selected >= 0 && !checkCard(hand[selected]));
if (selected < 0) {
drawAndSkip();
return false;
}
if (hand[selected].face & self.CardFace.WILD_EFFECT) {
const handColors = [];
hand.forEach((el) => {
if (el.color != self.Color.NONE &&
!handColors.includes(el.color)) {
handColors.push(el.color);
}
});
color = handColors.length == 0 ?
colorPairs[Math.floor(Math.random() * (colorPairs.length - 1)) +
1][1] :
handColors[Math.floor(Math.random() * handColors.length)];
}
if (hand.length == 2) {
if (Math.random() <= players[turn].probCallUno) {
const myId = players[turn].id;
setTimeout(function() {
callUno(myId);
}, players[turn].delayCallUno);
}
}
} else if (!text || !text.trim()) {
game.groupChannel.send(
'`Please specify a card, that you have, to play.`');
return false;
} else {
const parsed = parseToCard(text);
if (!parsed) {
game.groupChannel.send(
'`I\'m not sure what card that is.`\n' + text);
return false;
}
if (parsed.face & self.CardFace.WILD_EFFECT) {
if (parsed.color == self.Color.NONE) {
game.groupChannel.send(
'`Please specify a color to make this card.`');
return false;
} else {
color = parsed.color;
}
}
if (!((parsed.face == topCard.face) ||
(parsed.face & self.CardFace.WILD_EFFECT ||
parsed.color == topCard.color))) {
game.groupChannel.send(
'`That\'s not a valid card to play. The current card is`',
getCardEmbed(topCard));
return false;
}
selected = hand.findIndex((el) => {
return parsed.face == el.face &&
(parsed.face & self.CardFace.WILD_EFFECT ||
parsed.color == el.color);
});
if (selected < 0) {
game.groupChannel.send(
'`You don\'t have that card.` Please play a card that you ' +
'have, or \'draw\' to draw a card from the deck.');
return false;
}
}
}
const card = hand.splice(selected, 1)[0];
if (topCard) {
discarded.push(topCard);
}
topCard = card;
// previousCard = card;
if (color) {
card.color = color;
}
if (turn > -1 && players[turn].hand.length > 0) {
game.groupChannel.send(
'`' + players[turn].name + '` has ' + players[turn].hand.length +
' cards.',
getCardEmbed(card));
} else {
game.groupChannel.send(getCardEmbed(card));
}
if (hand.length == 0) {
game.groupChannel.send(
players[turn].mention + ' `has no cards remaining!`\n```' +
players[turn].name + ' is the winner!```');
if (players[turn].npc) endGame();
return true;
}
previousTurn = turn;
let skipping = false;
if (card.face & self.CardFace.REVERSE_EFFECT) {
direction *= -1;
if (players.length == 2) {
skipping = true;
}
}
/* if (card.face & self.CardFace.WILD_EFFECT && !card.color) {
waitingForColor = players[turn].id;
} */
nextTurn(skipping || card.face & self.CardFace.SKIP_EFFECT);
if (card.face & self.CardFace.DRAW_TWO_EFFECT) {
drawCards(2);
// previousCard = null;
}
if (card.face & self.CardFace.DRAW_FOUR_EFFECT) {
drawCards(4);
// previousCard = null;
}
if (skipping || card.face & self.CardFace.SKIP_EFFECT) {
nextTurn();
}
return false;
}
/**
* Parse a string of text to a playable card.
*
* @private
*
* @param {string} text The user-input to parse.
* @returns {?Uno.Card} The matched card, or null if no match.
*/
function parseToCard(text) {
const replaced = text.replace(/_/g, ' ');
const colorMatch = replaced.match(colorRegExp);
const faceMatch = replaced.match(cardFaceRegExp);
if (!faceMatch) return null;
if (faceMatch.length != 1) return null;
faceMatch[0] = faceMatch[0].replace(/ /g, '_');
let color = self.Color.NONE;
if (colorMatch && colorMatch.length == 1) {
color = self.Color[colorMatch[0].toUpperCase()];
}
const face = self.CardFace[faceMatch[0].toUpperCase()];
// If not a wild card, and no color was chosen.
if (!(face & self.CardFace.WILD_EFFECT) && color == self.Color.NONE) {
return null;
}
return new self.Card(face, color);
}
/**
* Checks if the given card may be played next.
*
* @see {@link Uno.Game~topCard}
*
* @private
* @param {Uno.Card} card The card to check.
* @param {Uno.Card} [card2] The card to check against. If not defined, the
* current topCard will be used.
* @returns {boolean} True if can be played, false otherwise.
*/
function checkCard(card, card2) {
if (card.face & self.CardFace.WILD_EFFECT) return true;
card2 = card2 || topCard;
const cardFace = card.face & self.CardFace.BASE_MASK;
const card2Face = card2.face & self.CardFace.BASE_MASK;
return (cardFace == card2Face) || (card.color == card2.color);
}
/**
* A player has called Uno. To say that they are about to have one card,
* they now have one card after playing, or the previous person now has one
* card and did not call Uno.
*
* @private
* @param {string|number} caller The user ID of the player who called Uno.
*/
function callUno(caller) {
if (players[turn] && players[turn].id == caller &&
!players[turn].calledUno && players[turn].hand.length == 2) {
players[turn].calledUno = true;
const mention = players[turn].mention;
game.groupChannel.send(`${mention} called\`\`\`\n${unoText}\n\`\`\``);
}
if (previousTurn > -1) {
if (players[previousTurn] && players[previousTurn].id == caller &&
!players[previousTurn].calledUno &&
players[previousTurn].hand.length == 1) {
players[previousTurn].calledUno = true;
const mention = players[previousTurn].mention;
game.groupChannel.send(`${mention} called\`\`\`\n${unoText}\n\`\`\``);
}
if (players[previousTurn] && !players[previousTurn].calledUno &&
players[previousTurn].hand.length == 1) {
game.groupChannel.send(
players[previousTurn].mention +
' `forgot to call "UNO!" and now must draw 2 cards!`');
const tmp = turn;
turn = previousTurn;
drawCards(2);
turn = tmp;
}
}
}
/**
* Ends this game and deletes all created channels.
*
* @public
*/
this.end = function() {
if (currentCollector) currentCollector.stop('Game has ended');
if (game.groupChannel) {
game.groupChannel.delete('The UNO game has ended.');
}
if (players) {
players.forEach((p) => {
if (p.channel) p.channel.delete('The UNO game has ended.');
});
}
if (game.catChannel) {
game.catChannel.delete('The UNO game has ended.');
}
delete games[maker.guild.id][game.id];
numGames--;
};
/**
* Add the given guild member to the game.
*
* @public
*
* @param {Discord~GuildMember} p The member to add to the game.
* @returns {boolean} Success if true, failed if false.
*/
this.addPlayer = function(p) {
if (!p) return;
if (!game.catChannel) {
memberList.push(p);
return true;
}
if (players.length >= maxPlayerCount) {
return false;
}
if (p.user.bot) {
players.push(
new self.NPC(
p.nickname || p.user.username, game, {id: p.id, bot: true}));
} else {
players.push(new self.Player(p, game));
}
game.groupChannel.updateOverwrite(
p.user.id, {
VIEW_CHANNEL: true,
SEND_MESSAGES: true,
},
'Player added to game.');
return true;
};
/**
* Add a certain number of NPCs into the game.
*
* @public
*
* @param {number} [num=1] The number of NPCs to add.
* @returns {boolean} Success if true, failed if false.
*/
this.addNPCs = function(num = 1) {
let added = 0;
for (let i = 0; i < num && players.length < maxPlayerCount; i++) {
let name;
const names = players.map((el) => el.name);
do {
name = npcNames[Math.floor(Math.random() * npcNames.length)];
} while (names.includes(name));
const npc = new self.NPC(name, game);
players.push(npc);
added++;
}
return added == num;
};
/**
* Remove a certain number of NPCs from the game.
*
* @public
*
* @param {number} [num=1] The number of NPCs to remove.
* @returns {boolean} Success if true, failed if false.
*/
this.removeNPCs = function(num = 1) {
let j = 0;
for (let i = 0; j < num && i < players.length; i++) {
if (players[i].npc && !players[i].bot) {
players.splice(i, 1);
i--;
j++;
}
}
return j == num;
};
/**
* Remove the user with the given ID from the game.
*
* @public
*
* @param {string|number|Discord~GuildMember|Uno.Player} p The ID of the
* user to remove.
*/
this.removePlayer = function(p) {
if (typeof p === 'object') p = p.id;
if (!p) return;
if (!players || !players.length || p.id == maker.id) return;
const index = players.findIndex((player) => player.id == p);
if (index > -1) {
players[index].remove();
discarded = discarded.concat(players[index].hand.splice(0));
players.splice(index, 1);
const perms = game.groupChannel.permissionOverwrites.get(p);
if (perms) perms.delete('User removed from game');
if (turn == index) nextTurn();
}
};
/**
* Returns the list of all players currently in this game.
*
* @public
*
* @returns {string[]|number[]} Array of player IDs. Type is number-like.
*/
this.getPlayers = function() {
return players.map((el) => {
return el.id;
});
};
};
/**
* A single player in the game.
*
* @public
* @param {Discord~GuildMember} member The guild member this is based off of.
* @param {Uno.Game} parent The parent game this player will be in.
*/
this.Player = function(member, parent) {
const player = this;
if (typeof member !== 'object') {
throw new Error('A new player must be based off of a GuildMember.');
}
const permOverwrites = [
{
id: member.guild.roles.everyone,
allow: 0,
deny: pFlags.VIEW_CHANNEL,
type: 'role',
},
{
id: member.id,
allow: pFlags.VIEW_CHANNEL,
deny: pFlags.SEND_MESSAGES,
type: 'member',
},
{
id: self.client.user.id,
allow: pFlags.VIEW_CHANNEL | pFlags.SEND_MESSAGES,
deny: 0,
type: 'member',
},
];
const channelOpts = Object.assign({
topic: (member.nickname || member.user.username) + '\'s UNO cards.',
parent: parent.catChannel,
permissionOverwrites: permOverwrites,
type: 'text',
reason: 'An UNO game was started.',
});
/**
* The Discord ID of this player.
*
* @public
* @readonly
* @type {string}
*/
this.id = member.id;
/**
* The name of this player.
*
* @public
* @readonly
* @type {string}
*/
this.name = member.nickname || member.user.username;
/**
* String for mentioning this user in chat.
*
* @public
* @readonly
* @type {string}
*/
this.mention = `<@${this.id}>`;
/**
* Whether this player is a npc or not. Must be false. Use Uno.NPC for bots.
*
* @public
* @readonly
* @default false
* @type {boolean}
*/
this.npc = false;
/**
* Whether this player has called uno recently.
*
* @public
* @type {boolean}
* @default
*/
this.calledUno = false;
/**
* The channel for this player's private messages for the game. Null until
* the channel is created.
*
* @public
* @readonly
* @type {?Discord~TextChannel}
*/
this.channel = null;
member.guild.channels
.create(
parent.catChannel.name + '-' +
(member.nickname || member.user.username),
channelOpts)
.then((channel) => {
player.channel = channel;
channel.send(
player.mention +
' You have been added to this game of Uno!\n\nThis channel ' +
'will show you the cards you currently have in your hand once ' +
'the game starts.\n\nUse <#' + parent.groupChannel.id +
'> to play your cards and talk to other players!');
})
.catch((err) => {
self.error(
'Failed to create private text channel for member: ' + member.id +
' in guild: ' + member.guild.id);
console.error(err);
if (parent.groupChannel) {
parent.groupChannel.send(
'Failed to create text channel for ' + member.user.tag);
}
});
/**
* The current cards that this player has in their hand.
*
* @public
* @type {Uno.Card[]}
*/
this.hand = [];
/**
* Remove this player from a game. Deletes the player's text channel.
*
* @public
*/
this.remove = function() {
if (player.channel) {
player.channel.delete('Player was removed from the UNO game.');
}
};
};
/**
* A single non-player character in the game. This is the same as a normal
* player, except they are not given a text channel, and their actions are
* controlled by us.
*
* @public
* @param {string} name The display name of this NPC.
* @param {Uno.Game} parent The parent game this player will be in.
* @param {NPCOpts} [options] Optional options for this NPC.
*/
this.NPC = function(name, parent, options) {
if (typeof options !== 'object') options = {};
/**
* The ID of this npc. Must be uniqueness is not enforced, but is required.
*
* @public
* @readonly
* @type {string}
*/
this.id = options.id || `NPC${name}`;
/**
* The name of this player.
*
* @public
* @readonly
* @type {string}
*/
this.name = name;
/**
* String for mentioning this user in chat.
*
* @public
* @readonly
* @type {string}
*/
this.mention = `\`${this.name}\``;
/**
* Whether this player is a Discord bot or not.
*
* @public
* @readonly
* @default false
* @type {boolean}
*/
this.bot = false;
if (typeof options.bot === 'boolean') this.bot = options.bot;
/**
* Whether this player is a NPC or not. Always true.
*
* @public
* @readonly
* @default true
* @type {boolean}
*/
this.npc = true;
/**
* Whether this player has called uno recently.
*
* @public
* @type {boolean}
* @default
*/
this.calledUno = false;
/**
* The current cards that this player has in their hand.
*
* @public
* @type {Uno.Card[]}
*/
this.hand = [];
/**
* Probability this NPC will call uno when necessary.
*
* @public
* @type {number}
* @default 0.5
*/
this.probCallUno = options.probCallUno || 0.5;
/**
* Delay before calling uno if this NPC is going to call it. (Milliseconds).
*
* @public
* @type {number}
* @default 3000
*/
this.delayCallUno = options.delayCallUno || 3000;
/**
* Remove this player from a game. Cleans up references if any exist.
*
* @public
*/
this.remove = function() {};
};
/**
* Format a hand of cards or a single card into Discord~MessageEmbed.
*
* @private
* @param {Uno~Card|Uno~Card[]} hand The card or hand of cards to format.
* @returns {Discord~MessageEmbed} The MessageEmbed to send to the user.
*/
function getCardEmbed(hand) {
const embed = new self.Discord.MessageEmbed();
const colors = {};
if (hand instanceof self.Card) hand = [hand];
hand.forEach((card) => {
if (!colors[card.color]) colors[card.color] = [card.toString()];
else colors[card.color].push(card.toString());
});
const noTitle = hand.length == 1;
colorPairs.forEach((c) => {
if (!colors[c[1]] || !c[1]) return;
colors[c[1]].sort();
const str = colors[c[1]].join('\n');
if (noTitle) {
embed.setTitle(str);
} else {
embed.addField(c[0], str, true);
}
});
if (colors[0]) {
colors[0].sort();
const str = colors[0].join('\n');
if (noTitle) {
embed.setTitle(str);
} else {
embed.addField('WILD', str, true);
}
} else if (hand.length == 1) {
if (hand[0].color == self.Color.YELLOW) {
embed.setColor('GOLD');
} else {
embed.setColor(colorPairs.find((el) => el[1] == hand[0].color)[0]);
}
}
return embed;
}
/**
* Takes a string that is all caps with underscores and makes it more human
* readable.
*
* @private
* @param {string} txt The text to format.
* @returns {string} The formatted text.
*/
function formatCard(txt) {
return txt.replace(/_/g, ' ')
.split(' ')
.map((el) => {
return el.charAt(0).toUpperCase() + el.substring(1).toLowerCase();
})
.join(' ');
}
/**
* @description A default hand of cards that the classic game starts with.
*
* @returns {Uno.Card[]} An array of all cards in a deck.
*/
this.getHand = function() {
const c = self.Color;
const f = self.CardFace;
/* eslint-disable no-multi-spaces */
return [
new self.Card(f.ZERO, c.RED), new self.Card(f.ZERO, c.GREEN),
new self.Card(f.ZERO, c.YELLOW), new self.Card(f.ZERO, c.BLUE),
new self.Card(f.ONE, c.RED), new self.Card(f.ONE, c.RED),
new self.Card(f.ONE, c.GREEN), new self.Card(f.ONE, c.GREEN),
new self.Card(f.ONE, c.YELLOW), new self.Card(f.ONE, c.YELLOW),
new self.Card(f.ONE, c.BLUE), new self.Card(f.ONE, c.BLUE),
new self.Card(f.TWO, c.RED), new self.Card(f.TWO, c.RED),
new self.Card(f.TWO, c.GREEN), new self.Card(f.TWO, c.GREEN),
new self.Card(f.TWO, c.YELLOW), new self.Card(f.TWO, c.YELLOW),
new self.Card(f.TWO, c.BLUE), new self.Card(f.TWO, c.BLUE),
new self.Card(f.THREE, c.RED), new self.Card(f.THREE, c.RED),
new self.Card(f.THREE, c.GREEN), new self.Card(f.THREE, c.GREEN),
new self.Card(f.THREE, c.YELLOW), new self.Card(f.THREE, c.YELLOW),
new self.Card(f.THREE, c.BLUE), new self.Card(f.THREE, c.BLUE),
new self.Card(f.FOUR, c.RED), new self.Card(f.FOUR, c.RED),
new self.Card(f.FOUR, c.GREEN), new self.Card(f.FOUR, c.GREEN),
new self.Card(f.FOUR, c.YELLOW), new self.Card(f.FOUR, c.YELLOW),
new self.Card(f.FOUR, c.BLUE), new self.Card(f.FOUR, c.BLUE),
new self.Card(f.FIVE, c.RED), new self.Card(f.FIVE, c.RED),
new self.Card(f.FIVE, c.GREEN), new self.Card(f.FIVE, c.GREEN),
new self.Card(f.FIVE, c.YELLOW), new self.Card(f.FIVE, c.YELLOW),
new self.Card(f.FIVE, c.BLUE), new self.Card(f.FIVE, c.BLUE),
new self.Card(f.SIX, c.RED), new self.Card(f.SIX, c.RED),
new self.Card(f.SIX, c.GREEN), new self.Card(f.SIX, c.GREEN),
new self.Card(f.SIX, c.YELLOW), new self.Card(f.SIX, c.YELLOW),
new self.Card(f.SIX, c.BLUE), new self.Card(f.SIX, c.BLUE),
new self.Card(f.SEVEN, c.RED), new self.Card(f.SEVEN, c.RED),
new self.Card(f.SEVEN, c.GREEN), new self.Card(f.SEVEN, c.GREEN),
new self.Card(f.SEVEN, c.YELLOW), new self.Card(f.SEVEN, c.YELLOW),
new self.Card(f.SEVEN, c.BLUE), new self.Card(f.SEVEN, c.BLUE),
new self.Card(f.EIGHT, c.RED), new self.Card(f.EIGHT, c.RED),
new self.Card(f.EIGHT, c.GREEN), new self.Card(f.EIGHT, c.GREEN),
new self.Card(f.EIGHT, c.YELLOW), new self.Card(f.EIGHT, c.YELLOW),
new self.Card(f.EIGHT, c.BLUE), new self.Card(f.EIGHT, c.BLUE),
new self.Card(f.NINE, c.RED), new self.Card(f.NINE, c.RED),
new self.Card(f.NINE, c.GREEN), new self.Card(f.NINE, c.GREEN),
new self.Card(f.NINE, c.YELLOW), new self.Card(f.NINE, c.YELLOW),
new self.Card(f.NINE, c.BLUE), new self.Card(f.NINE, c.BLUE),
new self.Card(f.DRAW_TWO, c.RED), new self.Card(f.DRAW_TWO, c.RED),
new self.Card(f.DRAW_TWO, c.GREEN), new self.Card(f.DRAW_TWO, c.GREEN),
new self.Card(f.DRAW_TWO, c.YELLOW), new self.Card(f.DRAW_TWO, c.YELLOW),
new self.Card(f.DRAW_TWO, c.BLUE), new self.Card(f.DRAW_TWO, c.BLUE),
new self.Card(f.SKIP, c.RED), new self.Card(f.SKIP, c.RED),
new self.Card(f.SKIP, c.GREEN), new self.Card(f.SKIP, c.GREEN),
new self.Card(f.SKIP, c.YELLOW), new self.Card(f.SKIP, c.YELLOW),
new self.Card(f.SKIP, c.BLUE), new self.Card(f.SKIP, c.BLUE),
new self.Card(f.REVERSE, c.RED), new self.Card(f.REVERSE, c.RED),
new self.Card(f.REVERSE, c.GREEN), new self.Card(f.REVERSE, c.GREEN),
new self.Card(f.REVERSE, c.YELLOW), new self.Card(f.REVERSE, c.YELLOW),
new self.Card(f.REVERSE, c.BLUE), new self.Card(f.REVERSE, c.BLUE),
new self.Card(f.WILD, c.NONE), new self.Card(f.WILD, c.NONE),
new self.Card(f.WILD, c.NONE), new self.Card(f.WILD, c.NONE),
new self.Card(f.DRAW_FOUR, c.NONE), new self.Card(f.DRAW_FOUR, c.NONE),
new self.Card(f.DRAW_FOUR, c.NONE), new self.Card(f.DRAW_FOUR, c.NONE),
];
/* eslint-enable no-multi-spaces */
};
}
module.exports = new Uno();