Camscaster.Com

Apps Home | Create an App
Random Tip Goal
Author: mx2k6
Description Source Code Launch App Current Users
Created by: Mx2k6
There are 3 other versions of this script.
/*
	Name:	Random Goal
	Author:	mx2k6

	Version History
	============================================
	v1.0 16/05/2014: First release
	v1.1 16/05/2014: Added ability to disable capping

	Credits and Props
	============================================
	Based on the bog standard tip goal app, with random goal amounts
*/


if (cb == null) {
	var cb = {
		changeRoomSubject: function (new_subject) { },
		drawPanel: function () { },
		log: function (message) { },
		onDrawPanel: function (func) { },
		onEnter: function (func) { },
		onLeave: function (func) { },
		onMessage: function (func) { },
		onTip: function (func) { },
		room_slug: '',
		sendNotice: function (message, to_user, background, foreground, weight, to_group) { },
		setTimeout: function (func, msec) { },
		settings_choices: [],
		settings: {},
		tipOptions: function (func) { },
		limitCam_start: function (message, allowed_users) { },
		limitCam_stop: function () { },
		limitCam_addUsers: function (allowed_users) { },
		limitCam_removeUsers: function (removed_users) { },
		limitCam_removeAllUsers: function () { },
		limitCam_userHasAccess: function (user) { },
		limitCam_allUsersWithAccess: function () { },
		limitCam_isRunning: function () { },
	};
}

cb.settings_choices = [
	{ name: 'tokens', label: 'Token Goal', type: 'int', minValue: 1, defaultValue: 1000 },
	{ name: 'minimum_random_tokens', label: 'Minimum threshold for random tip', type: 'int', minValue: 1, maxValue: 65535, defaultValue: 50 },
	{ name: 'maximum_random_tokens', label: 'Maximum limit/threshold for random tip', type: 'int', minValue: 1, maxValue: 65535, defaultValue: 1000 },
	{ name: 'goal_description', label: 'Goal Description', type: 'str', minLength: 1, maxLength: 255, defaultValue: 'Something Happens!' },
	{ name: 'cap_double_tokens', label: 'Cap at twice amount tipped', type: 'choice', choice1: 'Yes', choice2: 'No', defaultValue: 'Yes' }
];

var Colours = { AliceBlue: "#F0F8FF", AntiqueWhite: "#FAEBD7", Aqua: "#00FFFF", Aquamarine: "#7FFFD4", Azure: "#F0FFFF", Beige: "#F5F5DC", Bisque: "#FFE4C4", Black: "#000000", BlanchedAlmond: "#FFEBCD", Blue: "#0000FF", BlueViolet: "#8A2BE2", Brown: "#A52A2A", BurlyWood: "#DEB887", CadetBlue: "#5F9EA0", Chartreuse: "#7FFF00", Chocolate: "#D2691E", Coral: "#FF7F50", CornflowerBlue: "#6495ED", Cornsilk: "#FFF8DC", Crimson: "#DC143C", Cyan: "#00FFFF", DarkBlue: "#00008B", DarkCyan: "#008B8B", DarkGoldenRod: "#B8860B", DarkGrey: "#A9A9A9", DarkGreen: "#006400", DarkKhaki: "#BDB76B", DarkMagenta: "#8B008B", DarkOliveGreen: "#556B2F", DarkOrange: "#FF8C00", DarkOrchid: "#9932CC", DarkRed: "#8B0000", DarkSalmon: "#E9967A", DarkSeaGreen: "#8FBC8F", DarkSlateBlue: "#483D8B", DarkSlateGrey: "#2F4F4F", DarkTurquoise: "#00CED1", DarkViolet: "#9400D3", DeepPink: "#FF1493", DeepSkyBlue: "#00BFFF", DimGrey: "#696969", DodgerBlue: "#1E90FF", FireBrick: "#B22222", FloralWhite: "#FFFAF0", ForestGreen: "#228B22", Fuschia: "#FF00FF", Gainsboro: "#DCDCDC", GhostWhite: "#F8F8FF", Gold: "#FFD700", GoldenRod: "#DAA520", Grey: "#808080", Green: "#008000", GreenYellow: "#ADFF2F", HoneyDew: "#F0FFF0", HotPink: "#FF69B4", IndianRed: "#CD5C5C", Indigo: "#4B0082", Ivory: "#FFFFF0", Khaki: "#F0E68C", Lavender: "#E6E6FA", LavenderBlush: "#FFF0F5", LawnGreen: "#7CFC00", LemonChiffon: "#FFFACD", LightBlue: "#ADD8E6", LightCoral: "#F08080", LightCyan: "#E0FFFF", LightGoldenRodYellow: "#FAFAD2", LightGrey: "#D3D3D3", LightGreen: "#90EE90", LightPink: "#FFB6C1", LightSalmon: "#FFA07A", LightSeaGreen: "#20B2AA", LightSkyBlue: "#87CEFA", LightSlateGrey: "#778899", LightSteelBlue: "#B0C4DE", LightYellow: "#FFFFE0", Lime: "#00FF00", LimeGreen: "#32CD32", Linen: "#FAF0E6", Magenta: "#FF00FF", Maroon: "#800000", MediumAquaMarine: "#66CDAA", MediumBlue: "#0000CD", MediumOrchid: "#BA55D3", MediumPurple: "#9370DB", MediumSeaGreen: "#3CB371", MediumSlateBlue: "#7B68EE", MediumSpringGreen: "#00FA9A", MediumTurquoise: "#48D1CC", MediumVioletRed: "#C71585", MidnightBlue: "#191970", MintCream: "#F5FFFA", MistyRose: "#FFE4E1", Moccasin: "#FFE4B5", NavajoWhite: "#FFDEAD", Navy: "#000080", OldLace: "#FDF5E6", Olive: "#808000", OliveDrab: "#6B8E23", Orange: "#FFA500", OrangeRed: "#FF4500", Orchid: "#DA70D6", PaleGoldenRod: "#EEE8AA", PaleGreen: "#98FB98", PaleTurquoise: "#AFEEEE", PaleVioletRed: "#DB7093", PapayaWhip: "#FFEFD5", PeachPuff: "#FFDAB9", Peru: "#CD853F", Pink: "#FFC0CB", Plum: "#DDA0DD", PowderBlue: "#B0E0E6", Purple: "#800080", Red: "#FF0000", RosyBrown: "#BC8F8F", RoyalBlue: "#4169E1", SaddleBrown: "#8B4513", Salmon: "#FA8072", SandyBrown: "#F4A460", SeaGreen: "#2E8B57", SeaShell: "#FFF5EE", Sienna: "#A0522D", Silver: "#C0C0C0", SkyBlue: "#87CEEB", SlateBlue: "#6A5ACD", SlateGrey: "#708090", Snow: "#FFFAFA", SpringGreen: "#00FF7F", SteelBlue: "#4682B4", Tan: "#D2B48C", Teal: "#008080", Thistle: "#D8BFD8", Tomato: "#FF6347", Turquoise: "#40E0D0", Violet: "#EE82EE", Wheat: "#F5DEB3", White: "#FFFFFF", WhiteSmoke: "#F5F5F5", Yellow: "#FFFF00", YellowGreen: "#9ACD32" };
var Groups = { TokenHolders: 'cyan', Tippers: 'blue', Fans: 'green', Moderators: 'red' };
var NotificationType = { Error: 'e', Warning: 'w', Success: 's', Information: 'i' };

var Messenger = {
	sendModeratorNotice: function (str) {
		this.sendGenericMessage(str, Colours.Blue, '', '', Groups.Moderators);
	},
	sendErrorMessage: function (str, recipient, group) {
		this.sendGenericMessage(str, Colours.Red, '', recipient, group);
	},
	sendWarningMessage: function (str, recipient, group) {
		this.sendGenericMessage(str, Colours.Orange, '', recipient, group);
	},
	sendSuccessMessage: function (str, recipient, group) {
		this.sendGenericMessage(str, Colours.DarkGreen, '', recipient, group);
	},
	sendInfoMessage: function (str, recipient, group) {
		this.sendGenericMessage(str, Colours.Black, '', recipient, group);
	},
	sendGenericMessage: function (str, colour, background, recipient, group) {
		if (recipient != null && group != null) cb.sendNotice(str, recipient, '', colour, 'bold', '');
		cb.sendNotice(str, recipient, background, colour, 'bold', group);
	},
};

String.prototype.format = function () {
	var newString = String(this);
	for (var idx = 0; idx < arguments.length; idx++) {
		newString = newString.replace('{' + idx + '}', arguments[idx]);
	}
	return String(newString);
};

var Application = {
	title: 'Random Tip Goal',
	version: 1.1,

	Settings: {
		minimumTipThreshold: 0,
		maximumTipThreshold: 0,
		capDoubleTokens: true,
		interpret: function() {
			this.minimumTipThreshold = cb.settings.minimum_random_tokens;
			this.maximumTipThreshold = cb.settings.maximum_random_tokens;
			this.capDoubleTokens = (cb.settings.cap_double_tokens == 'Yes');
			Application.Goal.setTarget(cb.settings.tokens);
			Application.Goal.setDescription(cb.settings.goal_description);
		}
	},
	Debugger: {
		internal: {
			enabled: false,
		},
		setDebugMode: function(enabled) {
			this.internal.enabled = enabled;
		},
		getDebugMode: function() {
			return this.internal.enabled;
		},
		debugMessage: function(msg) {
			if (!this.internal.enabled) return;
			cb.log("[{0}] {1}".format(new Date().toString(), msg));
		},
	},
	Room: {
		internal: {
			subject: '',
		},
		setSubject: function(subject) {
			subject = "Random Tip Goal!  Goal: {0}".format(subject);
			Application.Debugger.debugMessage("Room subject changing to: {0}".format(subject));
			this.internal.subject = subject;
		},
		getSubject: function() {
			return this.internal.subject;
		},
	},
	Goal: {
		internal: {
			subjectIsFinal: false,
			highTipper: undefined,
			highTotal: 0,
			leaderboard: [],
			description: '',
			tokens: 0,
			target: 0,
		},
		// getRandomTokens returns an amount between the amount tipped and the maximum threshold, up to 2x the tipped amount
		getRandomTokens: function(tokens) {
			var maxCap = Application.Settings.capDoubleTokens ? (tokens * 2 > Application.Settings.maximumTipThreshold ? Application.Settings.maximumTipThreshold : tokens * 2) : Application.Settings.maximumTipThreshold;
			var randomTip = Math.floor(Math.random() * (maxCap - Application.Settings.minimumTipThreshold));
			randomTip += Application.Settings.minimumTipThreshold;
			return randomTip;
		},
		getTokensRemaining: function() {
			return this.internal.target - this.internal.tokens;
		},
		setTarget: function(tokens) {
			this.internal.target = tokens;
		},
		setDescription: function (desc) {
			this.internal.description = desc;
		},
		getTarget: function () {
			return this.internal.target;
		},
		getDescription: function () {
			return this.internal.description;
		},
		updateSubject: function() {
			Application.Room.setSubject(this.internal.description + " [{0} tokens remaining]".format(this.getTokensRemaining()));
		},
		addTip: function(username, tokens) {
			Application.Debugger.debugMessage("Tip of {0} received from {1}".format(tokens, username));
			var isFound = false;
			if (tokens >= Application.Settings.minimumTipThreshold && tokens <= Application.Settings.maximumTipThreshold) tokens = this.getRandomTokens(tokens);
			Application.Debugger.debugMessage("New tip: {0} from {1}".format(tokens, username));
			Messenger.sendSuccessMessage("Congratulations!  Your tip has counted for {0} tokens towards the goal!".format(tokens), username);
			for (var idx = 0; idx < this.internal.leaderboard.length; idx++) {
				if (this.internal.leaderboard[idx].name == username) {
					isFound = true;
					this.internal.leaderboard[idx].tokens += tokens;
					break;
				}
			}
			if (!isFound) {
				this.internal.leaderboard.push({ name: username, tokens: tokens });
			}
			this.internal.leaderboard.sort(function(a, b) {
				return b.tokens - a.tokens;
			});
			if (tokens > this.internal.highTotal) {
				this.internal.highTotal = tokens;
				this.internal.highTipper = username;
			}
			this.internal.tokens += tokens;
			this.updateSubject();
			this.cachePanel();
		},
		getHighTipper: function() {
			return this.internal.highTipper;
		},
		getHighTotalTipper: function() {
			return (this.internal.leaderboard.length > 0 ? this.internal.leaderboard[0].username : undefined);
		},
		drawPanel: function() {
			return this.internal.panel;
		},
		cachePanel: function() {
			Application.Debugger.debugMessage("Caching new panel");
			if (this.internal.subjectIsFinal) {
				this.internal.panel = {
					template: '3_rows_of_labels',
					row1_label: 'Total Tipped:',
					row1_value: this.getTarget(),
					row2_label: 'Highest Tip:',
					row2_value: '{0} ({1})'.format(formatUsername(this.getHighTipper()), this.internal.highTotal),
					row3_label: '',
					row3_value: 'Goal reached!  Thanks tippers!'
				};
			} else {
				this.internal.panel = {
					template: '3_rows_of_labels',
					row1_label: 'Remaining / Total',
					row1_value: '{0} / {1}'.format(this.getTokensRemaining(), this.getTarget()),
					row2_label: 'Highest Tip:',
					row2_value: '{0} ({1})'.format(formatUsername(this.getHighTipper()), (this.internal.highTotal == undefined ? '--' : this.internal.highTotal)),
					row3_label: 'Tip from min to max',
					row3_value: 'Min: {0} :: Max: {1}'.format(Application.Settings.minimumTipThreshold, Application.Settings.maximumTipThreshold)
				};
			}
			cb.drawPanel();
		},
	},

	onStart: function () { return true; },
	onTip: function (tip) { this.Goal.addTip(tip.from_user, tip.amount); return false; },
	onMessage: function (message) {
		if (message.user == this.Goal.getHighTipper()) {
			message.background = Colours.PowderBlue;
		}
		if (message.user == this.Goal.getHighTotalTipper()) {
			message.background = Colours.SkyBlue;
		}
		return message;
	},
	onEnter: function (username) { Messenger.sendInfoMessage("Welcome!  This room is running Random Tip Goal!  Tip between {0} and {1} to add a random tip toward the goal!".format(this.Settings.minimumTipThreshold, this.Settings.maximumTipThreshold), username); return false; },
	onLeave: function (username) { return false; },
	onDrawPanel: function () { return this.Goal.drawPanel(); }
};

function formatUsername(username) {
	if (username == undefined) {
		return "--";
	} else {
		return username.substring(0, 12);
	}
};

cb.onTip(function (tip) {
	if (!Application.onTip(tip)) return;
});

cb.onMessage(function (message) {
	return Application.onMessage(message);
});

cb.onEnter(function (username) {
	if (!Application.onEnter(username)) return;
});

cb.onLeave(function (username) {
	if (!Application.onLeave(username)) return;
});

cb.onDrawPanel(function() {
	return Application.onDrawPanel();
});

if (cb !== null && cb.settings !== null) {
	if (Application.onStart()) {
		if (cb.room_slug == 'mx2k6') Application.Debugger.setDebugMode(true);
		Application.Settings.interpret();
		Application.Goal.updateSubject();
		Application.Goal.cachePanel();
		Messenger.sendSuccessMessage("{0} v{1} has started.  Tip between {2} and {3} tokens to add a random tip towards the goal!".format(Application.title, Application.version, Application.Settings.minimumTipThreshold, Application.Settings.maximumTipThreshold));
	}
}