Chaturbate

Apps Home | Create an App
tipmasteralphas
Author: teasingcadence
Description Source Code Launch App Current Users
There are 11 other versions of this script.
//Tip Master v0.4
//Author: TeasingCadence
/*
PLEASE NOTE:  This script is in *beta*!  If something breaks, please let me know -- teasingcadence@gmail.com

When a user tips, they are buying time in control of the show (each token = x seconds, where x is the rate set by the broadcaster)

If there's already a user in control, tipping gets you queued up for afterwards

Goals are also implemented, and one can set multiple goals

There are several more commands documented below

Mod Commands:
==========
/commands
   Shows This Information
/setlimits description
   Sets the description of limits displayed in the help
/settotal tokens
   Sets the total number of tokens to a specified value 
/setrate seconds
   Sets the number of seconds bought by each token
/setgoal amount [description]
   Sets the goal to a specified amount w/ optional description
/cleargoal
   Skips the current goal
/skipuser
   Skips the current user
/empty
   Empties the user queue
/reset
   Resets the app to the state it started in
/pause
   Pauses the timer for the current controller
/resume
   Resumes the timer for the current controller
/showhelp
   Displays the help for the room to see

User Commands:
==========
/help
   Helps the requesting user
/queue
   Displays the queue for the current user
/me
   Allows a user to perform an action ala IRC
*/

//Globals
var queue, notices, tippers, goals, toys, rate, desc, running, timealive, totaltips, runamount;
cb.settings_choices = [
    {name:'rate', type:'int', minValue:1, default:3, label:'Seconds per token:'},
    {name:'desc', type: 'str', minLength: 0, maxLength: 255, label:'Limits, etc. (displayed in help):', required: false},
    {name:'gamount', type:'int', minValue:1, label:'Starting Goal Amount:', required: false},
    {name:'gdesc', type: 'str', minLength: 0, maxLength: 255, label:'Starting Goal Description:', required: false},
];

function init()
{
	queue = [];
	goals = [];
	notices = [];
	users = [];
	toys = [];
	tippers = {};
	rate = cb.settings.rate;
	desc = cb.settings.desc;
	
	if(cb.settings.gamount && cb.settings.gamount > 0) goals.push(makeGoal(cb.settings.gamount, cb.settings.gdesc, true));
	
	running = false;
	timealive = 0;
	totaltips = 0;
	runamount = 1;
	showHelp();
}

//Getters
function secondsToTime(s)
{
	if(typeof(s)!="number") {
		queueNotice("Error: seconds are not a number!  Value is "+s, cb.user_slug);
		return "-:--:--";
	}
	//Converts a number of seconds into a time string
	var r = [0,0,s];
	for(i = 2; i > 0; i--)
	{
		r[i-1] = Math.floor(r[i]/60);
		r[i] %= 60;
		if(r[i] < 10) r[i] = "0" + r[i];
	}
	return r.join(":");
}

function userInQueue(u) {
	//Checks if a user is in the queue; returns the position if so; returns -1 if not
	for(var i=0; i<queue.length; i++)
		if(u == queue[i].name)
			return i;
	return -1;
}

//Doers
function empty() {
	//Clear the queue and print help
	queue = [];
	running = false;
	showHelp();
}

function initUser() {
	//Announce the new Master
	queueNotice("It's your turn, "+queue[0].name+" :)");
	queueNotice(getRewards(queue[0].name).message);
	running = true;
}

function getSeconds(user)
{
	return (user.tokens*rate) + user.tp;
}

function endUser() {
	//Move on to the next user and either announce them or print help
	queue.shift();
	
	if(queue.length)
		initUser();
	else
		empty();
}

function showHelp(member, level) {
	//Prints the help, optionally to a specific member
	queueNotice("Tipping allows you to control the show!", member);
	queueNotice("Each token buys you "+rate+" seconds.  That's "+Math.round(60/rate)+" tokens per minute.", member);
	queueNotice("If someone is already in control, you will be queued up at the end of the line.", member);
	if(typeof(desc)=="string" && desc.length>0) queueNotice(desc, member);
	if(goals.length)
	{
		queueNotice("In "+(goals[0].amount - totaltips)+" tokens "+goals[0].description+"!!!", member);
		queueNotice('For more goals, type "/goals"', member);
	}
	if(toys.length)
	{
		queueNotice("I also have toys to use!! To see what they'll cost you, type \"/toys\"", member);
	}
	if(level)
	{
		queueNotice('For a list of commands, type "/commands"', member);
	}
}

function showGoals(member, level)
{
	//Prints the help, optionally to a specific member
	if(goals.length)
	{
		queueNotice(totaltips+" tokens have been tipped so far", member);
		for(var i=0; i<goals.length; i++)
		{
			queueNotice("Goal: At "+goals[i].amount+" tokens "+goals[i].description, member);
		}
	}
}

function setRewards(tokens, user)
{
	var prev = tippers[user];
	if(!prev) prev = 0;
	
	var pr = getRewards(user, true);
	
	tippers[user] = tokens + prev;
	
	var cr = getRewards(user, true);
	
	if(pr.number < cr.number)
		queueNotice(cr.message);
}

function getRewards(member, thirdperson)
{
	var tokens = tippers[member];
	if(tokens)
	{
		var unlocked = [];
		
		var message = thirdperson?(member+" has"):"You have";
		message += " spent "+tokens+" tokens";
		for(var i=0; toys[i].amount <= tokens; i++)
		{
			unlocked.push(toys[i].description);
		}
		switch(unlocked.length)
		{
			case 0:
				message += ".";
				break;
			case 1:
				message += ", unlocking the "+unlocked[0];
				break;
			default:
				var last = " and the "+unlocked.pop();
				message += unlocked.join(", ") + last;
				break;
		}
		var ret = {};
		ret.number = unlocked.length;
		ret.message = message;
		return ret;
	}
	return false;
}

function showToys(member, level)
{
	if(!toys.length) return;
	queueNotice("Bigger tips unlock better toys!!", member);
	var unlocked = getRewards(member).message;
	if(unlocked)
		queueNotice(unlocked, member);
	for(var i=0; i<toys.length; i++)
	{
		queueNotice(toys[i].amount+" tokens: "+toys[i].description, member);
	}
}

function showCommands(member)
{
	//TODO: Print Mod Commands
	queueNotice("Mod Commands:\n\
==========\n\
/commands\n\
	Shows This Information\n\
/setlimits description\n\
	Sets the personalized description displayed in the help\n\
/settotal tokens\n\
	Sets the total number of tokens to a specified value \n\
/setrate seconds\n\
	Sets the number of seconds bought by each token\n\
/setgoal amount [description]\n\
	Sets the goal to a specified amount w/ optional description\n\
/cleargoal\n\
	Skips the current goal\n\
/skipuser\n\
	Skips the current user\n\
/empty\n\
	Empties the user queue\n\
/reset\n\
	Resets the app to the state it started in\n\
/pause\n\
	Pauses the timer for the current controller\n\
/resume\n\
	Resumes the timer for the current controller\n\
/showhelp\n\
	Displays the help for the room to see\n\
\n\
User Commands:\n\
==========\n\
/help\n\
	Helps the requesting user\n\
/goals\n\
	Shows the list of queued goals\n\
/queue\n\
	Displays the queue for the current user\n\
/me\n\
	Allows a user to perform an action ala IRC :)", member);
}

function queueNotice(message, user)
{
	var notice = {};
	notice.message = message;
	notice.user = user;
	notices.push(notice);
}

//Main Loop
function mainLoop() {
	//Call the next iteration in one second
	cb.setTimeout(function(){mainLoop();}, 1000);
	timealive ++;
	
	if(notices.length)
	{
		cb.chatNotice(notices[0].message, notices[0].user);
		notices.shift();
	}
	
	//Update the queue
	if(running) {
		queue[0].seconds = getSeconds(queue[0]);
		
		if(queue[0].seconds == 0) {
			queueNotice("Time's up, "+queue[0].name+"!");
			endUser();
		}
		else {
			if(!queue[0].tp) {
				queue[0].tokens--;
				queue[0].tp = rate;
			}
			queue[0].tp-= runamount;
		}
	}
	
	//Update the view
	cb.drawPanel();
}

cb.onDrawPanel(function (user) {
	var view = {};
	if(!running) {
		//If the show is not running, explain how it works
		view.template = '3_rows_11_21_31';
		view.row1_value = 'Tip To Control The Show!';
		view.row2_value = 'Each Token Buys '+rate+' Seconds';
		
		if(timealive%6 < 3 && goals[0])
		{
			view.row3_value = 'Goal: '+totaltips+'/'+goals[0].amount;
		}
		else
		{
			view.row3_value = 'Type "/help" for more info';
		}
	}
    else {
	    //If the show is running, show the details
		view.template = '3_rows_of_labels';
		view.row1_label = 'Current Master:';
		view.row1_value = queue[0].name;
		view.row2_label = 'Time Left:';
		view.row2_value = secondsToTime(queue[0].seconds) +' ('+queue[0].tokens+' tokens)';
		if(timealive%6 < 3 && goals[0])
		{
			view.row3_label = 'Goal:';
			view.row3_value = totaltips+'/'+goals[0].amount;
		}
		else
		{
			view.row3_label = 'Next Up:';
			view.row3_value = (queue[1]?queue[1].name:"--");
		}
    }
    return view;
});

//Init the main loop
init();
mainLoop();


//Event Handlers
cb.onTip(function(tip){
	//If the user is not in the queue, add them to it with their tip
	//If they are, add the tip to their tokens value
	var u = tip['from_user'];
	var t = tip['amount'];
	
	var p = userInQueue(u);
	if(p==-1)
		queue.push({'name':u, 'tokens':t, 'tb':0, 'seconds':t*rate});
	else {
		queue[p].tokens += t;
		queue[p].seconds = getSeconds(queue[p]);
	}
	queueNotice("Thank you for your tip!", u);
	totaltips += t;
	
	var prev = 0;
	if(tippers[user])
	{
		toys
		tippers[user]+=amount;
		
	}
	else tippers[user] = amount;
	
	checkGoals();
	if(!running) initUser();
});

function checkGoals()
{
	goals = goals.sort(function(a,b){return a.amount - b.amount});
	var hit = 0;
	
	while(goals.length && totaltips >= goals[0].amount)
	{
		queueNotice("GOAL REACHED: "+goals[0].amount+"!!! "+goals[0].description);
		goals.shift();
		hit++;
	}
	
	if(goals.length && hit) queueNotice("Next Goal: "+goals[0].amount+" "+goals[0].description);
	return hit;
}

function userLevel(m) {
	if(typeof(m)=="string")
		m = {'name':m};
	
	if(m.user == cb.room_slug)
		return 2;
	else if(m.is_mod)
		return 1;
	else
		return 0;
}

function warn(user)
{
	queueNotice("Insufficient Privileges", user);
}

function makeGoal(amount, description, silent)
{
	if(!description) description = "";
	if(!silent) queueNotice("New Goal: At "+amount+" tokens "+description);

	var g = {};
	g.amount = amount;
	g.description = description;
	return g;
}

function me(message, user)
{
	queueNotice(user+" "+message);
}

cb.onMessage(function(m){
	//If the user is the current controller, make their message green
	if(userInQueue(m.user)==0)
		m['background'] = '#9F9';
	
	//If it does not start with a "/", just return it
	if(m.m.charAt(0) != "/")
		return m;
	
	//Hide the message as it is a command if it's reached this point
	m['X-Spam'] = true;	
	
	switch(m.m.match(/\S*/)[0]) {
		
		case "/setlimits":
			if(userLevel(m)) {
				var r = m.m.match(/^\/setlimits\s*(.*)/);
				if(r)
				{
					desc = r[1];
					showHelp();
				}
				else {
					queueNotice("Invalid Syntax; must be used: /setlimits description", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/settotal":
			if(userLevel(m)) {
				var r = m.m.match(/^\/settotal (\d+)/);
				if(r)
				{
					totaltips = r[1];
					queueNotice("Tip jar set to "+totaltips+" tokens");
					checkGoals();
				}
				else {
					queueNotice("Invalid Syntax; must be used: /settotal tokens", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
		
		case "/setrate":
			if(userLevel(m)) {
				var r = m.m.match(/^\/setrate (\d*[1-9]\d*)/);
				if(r)
				{
					var newrate = r[1];
					if(queue.length && queue[0].tp)
						queue[0].tp = Math.round((queue[0].tp/rate)*newrate);
					rate = newrate;
					queueNotice("Rate set to "+rate+" seconds per token");
				}
				else {
					queueNotice("Invalid Syntax; must be used: /setrate seconds", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
		
		case "/setgoal":
			if(userLevel(m)) {
				var r = m.m.match(/^\/setgoal (\d+)( .*)?/);
				if(r)
				{
					var g = makeGoal(r[1], r[2].substr(1));
					for(var i=0; i<goals.length; i++)
					{
						if(goals[i].amount == g.amount)
						{
							goals[i] = g;
							g = null;
						}
					}
					if(g) goals.push(g);
					checkGoals();
				}
				else {
					queueNotice("Invalid Syntax; must be used: /setgoal amount [Description]", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
		
		case "/cleargoal":
			if(userLevel(m)) {
				if(goals.length) {
					var r = m.m.match(/^\/cleargoal (\d+)/);
					if(r)
					{
						for(var i=0; i<goals.length; i++)
						{
							if(goals[i].amount == r[1])
							{
								queueNotice("Clearing goal at "+goals[i].amount+" tokens ("+goals[i].description+")...");
								goals.splice(i,1);
								i = goals.length+1;
							}
						}
						if(i==goals.length)
						{
							queueNotice("There is no goal set at "+r[1]+" tokens!", m.user);
						}
					}
					else {
						queueNotice("Clearing Lowest Goal...");
						goals.shift();
					}
				}
				else {
					queueNotice("There's no goal to skip!", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/settoy":
			if(userLevel(m)) {
				var r = m.m.match(/^\/settoy (.+) (\d+)/);
				if(r)
				{
					for(var i=0; i<toys.length; i++)
					{
						if(toys[i].description == r[1])
						{
							toys[i].amount = r[2];
							i = toys.length+1;
						}
					}
					if(i == toys.length)
					{
						var toy = {};
						toy.description = r[1];
						toy.amount  =r[2];
						toys.push(toy);
					}
				}
				else {
					queueNotice("Invalid Syntax; must be used: /settoy description tokens", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/cleartoy":
			if(userLevel(m)) {
				var r = m.m.match(/^\/cleartoy (.+)/);
				if(r)
				{
					for(var i=0; i<toys.length; i++)
					{
						if(toys[i].description == r[1])
						{
							toys.splice(i, 1);
							i = toys.length+1;
						}
					}
					if(i == toys.length)
					{
						queueNotice("Toy "+r[1]+" not found!", m.user);
					}
				}
				else {
					queueNotice("Invalid Syntax; must be used: /cleartoy description tokens", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
		
		
		case "/skipuser":
			if(userLevel(m)) {
				if(queue.length) {
					queueNotice("Skipping " + queue[0].name + "...");
					endUser();
				}
				else {
					queueNotice("There's no one to skip!", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/empty":
			if(userLevel(m)) {
				queueNotice("Emptying queue...");
				empty();
			}
			else {
				warn(m.user);
			}
			break;
		
		case "/reset":
			if(userLevel(m)) {
				queueNotice("Reseting app...");
				init();
			}
			else {
				warn(m.user);
			}
			break;
					
		case "/pause":
			if(userLevel(m)) {
				if(runamount) {
					queueNotice("Pausing timer...");
					runamount = 0;
				}
				else {
					queueNotice("Already Paused!", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;
		
		case "/resume":
			if(userLevel(m)) {
				if(!runamount) {
					queueNotice("Resuming timer...");
					runamount = 1;
				}
				else {
					queueNotice("Already Running!", m.user);
				}
			}
			else {
				warn(m.user);
			}
			break;

		case "/commands":
			if(userLevel(m)) {
				showCommands(m.user);
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/showhelp":
			if(userLevel(m)) {
				showHelp();
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/showgoals":
			if(userLevel(m)) {
				showGoals();
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/showtoys":
			if(userLevel(m)) {
				showGoals();
			}
			else {
				warn(m.user);
			}
			break;
			
		case "/help":
			showHelp(m.user, userLevel(m.user));
			break;
			
		case "/goals":
			showGoals(m.user, userLevel(m.user));
			break;
			
		case "/toys":
			showToys(m.user, userLevel(m.user));
			break;
			
		case "/me":
			var r = m.m.match(/\/me (.+)/);
			if(r)
				me(r[1], m.user);
			else
				queueNotice("Invalid syntax; must be used: /me message", m.user);
			break;

		case "/queue":
			var p = userInQueue(m.user);
			switch(p) {
				case -1:
					queueNotice("Tip to be added to the queue!  Type '/help' for more info", m.user);
					break;
				case 0:
					queueNotice("You are currently in control of the show!", m.user);
					break;
				case 1:
					queueNotice("You are next in line!", m.user);
					break;
				case 2:
					queueNotice("There is 1 user in line ahead of you", m.user);
					break;
				default:
					queueNotice("There are "+(p-1)+" users in line ahead of you", m.user);
			}
			if(!queue.length)
				queueNotice("There is no current queue", m.user);
			else
			{
				queueNotice("Current queue:", m.user);
				for(var i=0; i<queue.length; i++) {
					queueNotice(i+" - "+queue[i].name+": "+queue[i].tokens+" tokens ("+secondsToTime(queue[i].seconds)+")", m.user);
				}
			}
			break;
			
		default:
			queueNotice(m.m+" is not a valid command", m.user);
			break;
	}
	return m;
});