Chaturbate

Bots Home | Create an App
GRAB BAG
Author: devils__advocate
Description Source Code Launch Bot Current Users
There are 5 other versions of this script.
/*
	Name:			GRAB BAG
	Author:			devils__advocate
	Last Modified:		2023-07-04
	
	The moral right of "devils__advocate" to be identified as the author of this work has been asserted.

	Version History
	============================================
	v1.0 2023-07-04: First release

	To-Do
	============================================
	N/A
*/

const VERSION = '1.0';
const LAST_UPDATED = '2023-07-04';
const AUTHOR = 'devils__advocate';

class Prize {
    constructor(number, name) {
        this.number = number;
        this.name = name;
        this.winner = null;
        this.dateTimeWon = null;
    }

    toString() {
        return `This is an instance of prize number ${this.number}, which is ${this.name}.`;
    }
}

class GrabBag {
    constructor(allowPeek) {
        this.prizes = [];
        this.distinctPrizes = []; // will contain one instance of each type of prize added, regardless of whether that prize is still available
        this.peekingIsAllowed = allowPeek === YES ? true : false;
        this.awardedPrizes = [];
    }

    addPrize(prize) {
        this.prizes.push(prize);
        if(this.distinctPrizes.filter(x => x.name === prize.name).length === 0) {
            this.distinctPrizes.push(prize);
        }
    }

    isPrizeNumberAvailable(prizeNumber) {
        return this.prizes.filter(x => x.number === prizeNumber).length > 0;
    }

    isPrizeNameAvailable(prizeName) {
        return this.prizes.filter(x => x.name === prizeName).length > 0;
    }

    getDistinctPrizes() {
        return this.distinctPrizes.sort((a, b) => a.number - b.number)
    }

    getPrizeNameByPrizeNumber(prizeNumber) {
        for(let prize of this.distinctPrizes) {
            if(prize.number === prizeNumber) {
                return prize.name;
            }
        }
        return "Invalid Prize Name";
    }

    getPrizeNumberByPrizeName(prizeName) {
        for(let prize in this.distinctPrizes) {
            if(prize.name === prizeName) {
                return prize.number;
            }
        }
        return "Invalid Prize Number";
    }

    awardBlindPrize(user) {
        var prize = null;
        let randomIndex = Math.floor(Math.random() * this.prizes.length)
        prize = this.prizes.splice(randomIndex,1)[0];
        prize.winner = user;
        const dateTime = new Date().toJSON();
        prize.dateTimeWon = dateTime;
        this.awardedPrizes.push(prize);
        return prize;
    }

    awardPrizeNumber(prizeNumber, user) {
        var prize = null;
        for(let i = 0; i < this.prizes.length; i++) {
            if (this.prizes[i].number === prizeNumber) {
                prize = this.prizes.splice(i,1)[0];
                prize.winner = user;
                const dateTime = new Date().toJSON();
                prize.dateTimeWon = dateTime;
                this.awardedPrizes.push(prize);
                return prize;
            }
        }
    }

    buildAwardMessage(prize, user) {
        if(prize) {
            let message = user + " has been awarded ----- " + prize.name;
            return message;
        } else if(cb.settings.consolationPrize) {
            return appName + ": There are no other prizes available, so " + user + " gets ----- " + cb.settings.consolationPrize;
        }
    }

    removeAllPrizeName(prizeName) {
        this.prizes = this.prizes.filter(x => x.name !== prizeName)
    }

    addSomePrizeName(prizeName, prizeNumber, quantity) {
        for(var i = 0; i < quantity; i++) {
            this.addPrize(new Prize(+prizeNumber, prizeName))
        }
    }

    setQuantityOfPrizeName(prizeName, prizeNumber, quantity) {
        this.removeAllPrizeName(prizeName);
        this.addSomePrizeName(prizeName, prizeNumber, quantity);
    }

    prizeNames() {
        let prizeNames = []
        for (let prize of this.prizes) {
            if(!prizeNames.includes(prize.name)) {
                prizeNames.push(prize.name);
            }
        }
        return prizeNames;
    }

    numberOfPrizeName(prizeName) {
        return this.prizes.filter(x => x.name === prizeName).length;
    }

    oddsForPrizeName(prizeName) {
        let numberOfPrizes = this.numberOfPrizeName(prizeName);
        if(numberOfPrizes > 0) {
            return (numberOfPrizes / this.prizes.length * 100).toFixed(2);
        }
        return "0.00";
    }

    hasAvailablePrizes() {
        return this.prizes.length > 0;
    }

    setIsPeekingAllowed(value) {
        this.peekingIsAllowed = value === YES ? true : false;
    }
}

class Messenger {
    constructor() {}

    messageSend(message, user = '', background = '', foreground = '', weight = '', group = ''){
        cb.sendNotice(message, user, background, foreground, weight, group)
    }

    buildHelpMessage() {
        var help = "Commands:\n";
        help += "The following commands are for everyone: \n";
        help += "/gblist: send the list of available prizes to yourself.\n";
        help += "/gbrules: send the rules of " + appName + " to yourself.\n";
        help += "/gbwinners: send the list of the last 20 prizes awarded to yourself.\n";
        help += "/gbhelp: send this list of commands to yourself.\n";
        help += LINE;
        help += "The following commands are for Broadcaster and Mods only: \n";
        help += "/gblist_all: Send the list of available prizes to everyone.\n";
        help += "/gbrules_all: Send the rules of " + appName + " to everyone.\n";
        help += LINE;
        help += "The following commands are for Broadcaster only: \n";
        help += "/gbset: Set the number available for one or more specific prizes.\n"; 
        help += "- /gbset command syntax: '/gbset <prize #> <quantity> <prize #> <quantity>'. Add any number of <prize #> <quantity> number pairs. Do not include the quotes.\n";
        help += "- /gbset example #1: '/gbset 5 2' will set the available quantity of prize #5 to 2. Do not include the quotes.\n";
        help += "- /gbset example #2: '/gbset 1 1 3 1 5 2' will set the available quantity of prize #1 to 1, the available quanitity of prize #3 to 1, and the available quantity of prize #5 to 2. Do not include the quotes.\n";
        help += "/gbpeek_on: Enable Peek Mode.\n";
        help += "/gbpeek_off: Disable Peek Mode.\n";
    
        return help;
    }

    buildTitleMessage(type) {
        var tag = "Tip " + cb.settings.tipAmount + " tokens to take a prize from the bag."
        if(type === "prize list") {
            tag = "List of available prizes."
        } else if(type === "instructions") {
            tag = "Instructions."
        } else if(type === "winners") {
            tag = "Last 20 winners."
        } else if(type === "help") {
            tag = "Help."
        }
        return appName + ": " + tag;
    }
    
    buildWinnersMessage(user = '') {
        var message = "This is the list of up to the last 20 prizes awarded:\n"
        message += `A total of ${bag.awardedPrizes.length} prizes have been awarded so far.\n`
        let startingIndex = bag.awardedPrizes.length - 1;
        let numberToPrint = bag.awardedPrizes.length >= 19 ? 19 : bag.awardedPrizes.length;
        if(bag.awardedPrizes.length > 0) {
            for(let i = startingIndex; i >= startingIndex - numberToPrint; i--) {
                let prize = bag.awardedPrizes[i];
                if(prize) {
                    if(user === cb.room_slug) {
                        message += `${prize.dateTimeWon}: `;
                    }
                    message += `Award #${i + 1} - ${prize.winner} won - #${prize.number}: ${prize.name}.\n`
                }
            }
        }
        return message;
    }
    
    buildInstructionsMessage(initialMessage = '') {
        let instructions = '';
        if(initialMessage) instructions += initialMessage;
        instructions += "Your broadcaster has put some very nice prizes into a Bag. Do you want one?\n"
        instructions += `Tip exactly ${cb.settings.tipAmount} token${cb.settings.tipAmount === 1 ? '' : 's'} to pull a prize from the bag. \n`
        instructions += LINE;
    
        if(bag.hasAvailablePrizes() && bag.peekingIsAllowed) {
            let examplePrize = bag.prizes[0];
            instructions += "Peeking is allowed! If you want to select a specific prize, put the prize number in the tip note (and nothing else).\n"
            instructions += `Example: To select the prize '${examplePrize.name}', tip ${cb.settings.tipAmount} token${cb.settings.tipAmount === 1 ? '' : 's'} and enter the number ${examplePrize.number} (and nothing else) in the tip note.\n`
            instructions += LINE;
        }
        if(cb.settings.consolationPrize) {
            instructions += "Consolation Prize: " + cb.settings.consolationPrize + "\n"
            instructions += "If you tip and the bag is empty, you will be awarded the consolation prize.\n"
            instructions += LINE;
        }
        return instructions;
    }
    
    buildPrizeListMessage(initialMessage = '') {
        let warningText = initialMessage;
        if(bag.hasAvailablePrizes()) {
            warningText += "Prize availability changes. Always refer to the most recently displayed prize list before tipping.\n";
            warningText += LINE;
            let prizeText = warningText + "Available Prizes:\n"
            prizeText += `Tip ${cb.settings.tipAmount} token${cb.settings.tipAmount === 1 ? 's' : ''} to claim a prize. `;
            if(cb.settings.allowPeek === YES) {
                prizeText += `Peeking is allowed! Add the prize number in your tip note if you want to select a specific prize.`
            }
            prizeText += "\n"
    
            for(let prize of bag.distinctPrizes) {
                let numberAvailable = bag.numberOfPrizeName(prize.name);
                if(numberAvailable > 0) {
                    prizeText += `Prize #${prize.number}: `
                    prizeText += prize.name 
                    if(cb.settings.displayPrizeData === YES) {
                        prizeText += " (" + numberAvailable + " available, odds to win: " + bag.oddsForPrizeName(prize.name) + "%)"
                    }
                    prizeText += "\n"
                }
            }
            return prizeText;
        } else {
            let allPrizesClaimedMessage = "All available prizes have been awarded.";
            return allPrizesClaimedMessage;
        }
    }

}

let appName = "GRAB BAG"
let initialMessage = "Welcome to " + appName + "!\n"
var prizeList = {};
let background = "#DDDDDD";
let foreground = "#228B22";
let weight = '';
var totalNumberOfPrizes = 0;
var showIntervalID = 0;

const MAX_PRIZES = 10;
const PRIZE = "prize";
const LIMIT = "Limit";
const DESC = "Desc";
const YES = "Yes";
const NO = "No";
const LINE = "-------\n"
const STAR = "☆"
const SHADE = "░"
const HEART = "❤"


let bag = new GrabBag(NO);
let msgr = new Messenger();

function setSettings(){
    cb.settings_choices = [
        {
            name:'tipAmount', type:'int',
            minValue: 1, default: 10, label: "Amount users must tip to select a prize"
        },
        {
            name:'showInterval', type:'int',
            minValue: 1, maxValue: 15, default: 5, label: "How often to show options list (in minutes)"
        },
        {
            name:'allowPeek', type:'choice',choice1:YES,choice2:NO,defaultValue:NO,label:"Peek mode: Allow users to select a prize by including prize number in tip note"
        },
        {
            name:'backgroundColor', type:'str',label:"Enter HEX value for background color (ex. #DDDDDD):", defaultValue: background, required: true
        },
        {
            name:'foregroundColor', type:'str',label:"Enter HEX value for the text color (ex. #228B22):", defaultValue: foreground, required: true
        },
        {
            name:'displayPrizeData', type:'choice',choice1:YES,choice2:NO,defaultValue:NO,label:"When displaying the prize list, show users the number of prizes of each type remaining, and the odds of selecting that prize", required: true
        },
        {
            name: PRIZE + '1' + DESC, type:'str', label: "Prize #1 description"
        },
        {
            name: PRIZE + '1' + LIMIT, minValue: 0, type:'int', label: "Prize #1 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '2' + DESC, type:'str', label: "Prize #2 description", required: false
        },
        {
            name: PRIZE + '2' + LIMIT, minValue: 0, type:'int', label: "Prize #2 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '3' + DESC, type:'str', label: "Prize #3 description", required: false
        },
        {
            name: PRIZE + '3' + LIMIT, minValue: 0, type:'int', label: "Prize #3 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '4' + DESC, type:'str', label: "Prize #4 description", required: false
        },
        {
            name: PRIZE + '4' + LIMIT, minValue: 0, type:'int', label: "Prize #4 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '5' + DESC, type:'str', label: "Prize #5 description", required: false
        },
        {
            name: PRIZE + '5' + LIMIT, minValue: 0, type:'int', label: "Prize #5 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '6' + DESC, type:'str', label: "Prize #6 description", required: false
        },
        {
            name: PRIZE + '6' + LIMIT, minValue: 0, type:'int', label: "Prize #6 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '7' + DESC, type:'str', label: "Prize #7 description", required: false
        },
        {
            name: PRIZE + '7' + LIMIT, minValue: 0, type:'int', label: "Prize #7 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '8' + DESC, type:'str', label: "Prize #8 description", required: false
        },
        {
            name: PRIZE + '8' + LIMIT, minValue: 0, type:'int', label: "Prize #8 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '9' + DESC, type:'str', label: "Prize #9 description", required: false
        },
        {
            name: PRIZE + '9' + LIMIT, minValue: 0, type:'int', label: "Prize #9 limit (will be set to 1 if left blank)", required: false
        },
        {
            name: PRIZE + '10' + DESC, type:'str', label: "Prize #10 description", required: false
        },
        {
            name: PRIZE + '10' + LIMIT, minValue: 0, type:'int', label: "Prize #10 limit (will be set to 1 if left blank)", required: false
        },
        {
            name:'consolationPrize', type:'str', label: "Consolation prize description (leave blank for none)", required: false
        }
    ];
}

cb.onMessage(function (msg) {
    var msgString = msg['m'].trim();
    var user = msg['user'];
    var is_mod = msg['is_mod'];
    var is_room_owner = msg['user'] === cb.room_slug;
    var isCommand = msgString.charAt(0).match(/(\/|!)/gi);

    if(isCommand) {
        if(msgString === '/gblist') {
            msgr.messageSend(msgr.buildTitleMessage("prize list"), user, foreground, background, "bold");
            let prizeList = msgr.buildPrizeListMessage();
            msgr.messageSend(prizeList, user, background, foreground, '')
        } else if(msgString === "/gbrules") {
            let instructions = msgr.buildInstructionsMessage();
            msgr.messageSend(msgr.buildTitleMessage("instructions"), user, foreground, background, "bold");
            msgr.messageSend(instructions, user, background, foreground, '')
        } else if(msgString === '/gbwinners') {
            let winners = msgr.buildWinnersMessage(user);
            msgr.messageSend(msgr.buildTitleMessage("winners"), user, foreground, background, "bold");
            msgr.messageSend(winners, user, background, foreground, '')
        } else if(msgString === '/gbhelp') {
            let help = msgr.buildHelpMessage();
            msgr.messageSend(msgr.buildTitleMessage("help"), user, foreground, background, "bold");
            msgr.messageSend(help, user, background, foreground, '');
        } else if(is_mod || is_room_owner) {
            if(msgString === '/gblist_all') {
                cb.cancelTimeout(showIntervalID); // since we're printing the prize list, cancel the timeout to display the prize list on interval.
                msgr.messageSend(msgr.buildTitleMessage("prize list"), '', foreground, background, "bold");
                let prizeList = msgr.buildPrizeListMessage();
                msgr.messageSend(prizeList, '', background, foreground, '')
                showIntervalID = cb.setTimeout(displayPrizeListOnInterval, 1000 * 60 * cb.settings.showInterval); // reset the timer for the interval display.
            } else if(msgString === "/gbrules_all") {
                let instructions = msgr.buildInstructionsMessage();
                msgr.messageSend(msgr.buildTitleMessage("instructions"), '', foreground, background, "bold");
                msgr.messageSend(instructions, '', background, foreground, '');
            } else if(msgString.startsWith("/gbset") && is_room_owner) {
                let elements = msgString.split(" ")
                for (var i = 1; i < elements.length; i++) {
                    if(i % 2 == 1) {
                        if(isNumeric(elements[i]) && isNumeric(elements[i + 1])) {
                            let prizeNumber = +elements[i];
                            let quantity = elements[i + 1];
                            let prizeName = bag.getPrizeNameByPrizeNumber(prizeNumber)
                            if(prizeName !== "Invalid Prize Name") {
                                bag.setQuantityOfPrizeName(prizeName, prizeNumber, quantity)
                            }
                        } else {
                            msgr.messageSend("/gbset error. The command entered was not correct. Command: '" + msgString + "'. Please be sure to format the command correctly.", user, foreground, background, "bold")
                        }
                    }
                }
                cb.cancelTimeout(showIntervalID); // since we're printing the prize list, cancel the timeout to display the prize list on interval.
                msgr.messageSend(msgr.buildTitleMessage("prize list"), '', foreground, background, "bold");
                let message = "The list of available prizes has been updated:\n"
                let prizeList = msgr.buildPrizeListMessage(message);
                msgr.messageSend(prizeList, '', background, foreground, '');
                showIntervalID = cb.setTimeout(displayPrizeListOnInterval, 1000 * 60 * cb.settings.showInterval); // reset the timer for the interval display.

            } else if(msgString.startsWith("/gbpeek_on") && is_room_owner) {
                bag.setIsPeekingAllowed(YES);
                msgr.messageSend(appName + ": Peeking has been enabled.", '', foreground, background, "bold");
                let instructions = msgr.buildInstructionsMessage();
                msgr.messageSend(msgr.buildTitleMessage("instructions"), '', foreground, background, "bold");
                msgr.messageSend(instructions, '', background, foreground, '');
            } else if(msgString.startsWith("/gbpeek_off") && is_room_owner) {
                bag.setIsPeekingAllowed(NO);
                msgr.messageSend(appName + ": Peeking has been disabled.", '', foreground, background, "bold");
                let instructions = msgr.buildInstructionsMessage();
                msgr.messageSend(msgr.buildTitleMessage("instructions"), '', foreground, background, "bold");
                msgr.messageSend(instructions, '', background, foreground, '');
            } else {
                msgr.messageSend(appName + ": The command '" + msgString + "' is either not valid or not available to you. Type /gbhelp for the list of commands.", user, foreground, background, 'bold')
            }
        } else {
            msgr.messageSend(appName + ": The command '" + msgString + "' is either not valid or not available to you. Type /gbhelp for the list of commands.", user, foreground, background, 'bold')
        }
        msg['X-Spam'] = true;
    }

    return msg
});

cb.onTip(function (tip) {

    //  example tip object: {"amount":1,"from_user":"dev_devils__advocate_02","from_user_gender":"m","from_user_has_tokens":true,"from_user_in_fanclub":false,"from_user_is_mod":false,"from_user_tipped_alot_recently":false,"from_user_tipped_recently":false,"from_user_tipped_tons_recently":false,"is_anon_tip":false,"message":'',"to_user":"dev_devils__advocate_01"} 

    if(isValidTipAmount(tip.amount)) {
        var tipMessage = '';
        if(bag.peekingIsAllowed) {
            if(isValidTipNote(tip.message)) {
                if(bag.isPrizeNumberAvailable(+tip.message)) {
                    let prize = bag.awardPrizeNumber(+tip.message, tip.from_user)
                    tipMessage += bag.buildAwardMessage(prize, tip.from_user);
                } else if (bag.hasAvailablePrizes()) {
                    tipMessage += "The prize you selected is not available, so a random available prize will be awarded.\n";
                    let prize = bag.awardBlindPrize(tip.from_user);
                    tipMessage += bag.buildAwardMessage(prize, tip.from_user);
                } else {
                    if(cb.settings.consolationPrize) {
                        tipMessage += "No other prizes available, so " + tip.from_user + " gets ----- " + cb.settings.consolationPrize + "!";
                    } else {
                        tipMessage += "No prizes are available. Thanks for the tip, " + tip.from_user + "!";
                    }
                }
            } else {
                if (bag.hasAvailablePrizes()) {
                    tipMessage += "An available prize was not selected, so a random available prize will be awarded.\n";
                    let prize = bag.awardBlindPrize(tip.from_user);
                    tipMessage += bag.buildAwardMessage(prize, tip.from_user);
                } else {
                    if(cb.settings.consolationPrize) {
                        tipMessage += "No other prizes available, so " + tip.from_user + " gets ----- " + cb.settings.consolationPrize + "!"
                    } else {
                        tipMessage += "No prizes are available. Thanks for the tip, " + tip.from_user + "!";
                    }
                }
            }
        } else {
            if (bag.hasAvailablePrizes()) {
                let prize = bag.awardBlindPrize(tip.from_user);
                tipMessage += bag.buildAwardMessage(prize, tip.from_user);
            } else {
                if(cb.settings.consolationPrize) {
                    tipMessage += "No other prizes available, so " + tip.from_user + " gets ----- " + cb.settings.consolationPrize + "!";
                } else {
                    tipMessage += "No prizes are available. Thanks for the tip, " + tip.from_user + "!";
                } 
            }
        }
        cb.cancelTimeout(showIntervalID); // since we're printing the prize list, cancel the timeout to display the prize list on interval.
        let prizeListMessage = msgr.buildPrizeListMessage();
        msgr.messageSend(appName + ": " + tipMessage, '', foreground, background, "bold");
        msgr.messageSend(appName + ": " + prizeListMessage, '', background, foreground, '')
        showIntervalID = cb.setTimeout(displayPrizeListOnInterval, 1000 * 60 * cb.settings.showInterval); // reset the timer for the interval display.
    } else {
        // msgr.messageSend(tip.amount + " is the wrong amount, so nothing will happen.");
    }    
});

cb.onStart(user => {
    cb.chatNotice(`${user['user']} is running ${appName}, created from scratch by ${AUTHOR}. Enter /gbhelp for a list of commands. Version: ${VERSION}. Last Updated: ${LAST_UPDATED}`);
    showIntervalID = cb.setTimeout(displayPrizeListOnInterval, 1000 * 60 * cb.settings.showInterval);

    let instructions = msgr.buildInstructionsMessage();
    let prizeList = msgr.buildPrizeListMessage(instructions);
    msgr.messageSend(msgr.buildTitleMessage(''), '', foreground, background, "bold");
    msgr.messageSend(prizeList, '', background, foreground, '');
});

function buildPrizeList() {
    for (var i = 1; i <= MAX_PRIZES; i++) {
        let name = cb.settings[PRIZE + i + DESC]
        let number = cb.settings[PRIZE + i + LIMIT]
        for(var j = 0; j < number; j++) {
            bag.addPrize(new Prize(i, name))
        }
    }
}

function isValidTipAmount(amount) {
    return amount === cb.settings.tipAmount;
}

function isValidTipNote(note) {
    return +note > 0;
}

function displayPrizeListOnInterval() {
    msgr.messageSend(msgr.buildTitleMessage("prize list"), '', foreground, background, "bold");
	msgr.messageSend(msgr.buildPrizeListMessage(), '', background, foreground, '');

	showIntervalID = cb.setTimeout(displayPrizeListOnInterval, 1000 * 60 * cb.settings.showInterval);

};

function isNumeric(value) {
    return /^-?\d+$/.test(value);
}

function init() {
    setSettings();
    buildPrizeList();
    bag.setIsPeekingAllowed(cb.settings.allowPeek);

    background = cb.settings.backgroundColor;
    foreground = cb.settings.foregroundColor;
}

init();