Chaturbate

Bots Home | Create an App
Night Flight Bot
Author: kukupuku
You are viewing version 119359. There is a newer version of this app. See the latest version of this app.

Description Source Code Launch Bot Current Users
Created by: Kukupuku
There are 59 other versions of this script.
/*
 Night Flight Members Bot
 Version: 1.5
 Modified by kukupuku original app dev * tablesalt90 *
 Night Flight Members Bot created for temptation82 - chaturbate.com/temptation82/
 */


/*
 * Setup vars
 */

var TravelerUsersArray = new Array();
var PassengersUsersArray = new Array();
var ExplorerUsersArray = new Array();
var VipUsersArray = new Array();
var Air_MarshalUsersArray = new Array();
var specialNames = new Array();
var tempString = "";
var tempArray = new Array();
var botVersion = "1.5";
var modelName = cb.room_slug;
var msgNotify = "";
var msgPublic = "";
var msgPrivate = "";
var msgModel = "";
var autoNotice1Text = "";
var autoNotice2Text = "";
var botTrigger = "/NFBOT";

var modCommands = true;
var userGreets = true;
var genderEmotes = true;

var botMsgBg = '#FF0000';
var botAlertBg = '#D32B2B';
var botNoteBg = '#99FF66';

specialNames[0] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[1] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[2] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[3] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[4] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[5] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[6] = new Array('name of user', 'Greeting text when user enter the room');
specialNames[7] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[8] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[9] = new Array('name of user', 'Greeting text when user enter the room');
specialNames[10] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[11] = new Array('Name of user', 'Greeting text when user enter the room');
specialNames[12] = new Array('Name of user', 'Greeting text when user enter the room');

/*
 * Settings
 */
cb.settings_choices = [
		{		name: 'genderEmotes', 
				type: 'choice', 
				label: 'Show users gender',
        		choice1: 'Yes',
        		choice2: 'No', 
        		defaultValue: 'No'
        },
        {		name: 'autoNotice1',
				label: 'Notification 1',
				type: 'str',
				minLength: 0,
				maxLength: 512,
				required: false,
				defaultValue: ''
		},
		{		name: 'autoNotice1Interval',
				label: 'Show Notification 1 in Minutes',
				type: 'choice',
        		choice1: 2,
        		choice2: 5,
        		choice3: 8,
        		choice4: 10,
        		choice5: 12,				
				choice6: 15,
				choice7: 20,
				choice8: 25,
				choice9: 30,
				choice10: 45,
				choice11: 60,
        		defaultValue: 2
		},
        {		name: 'autoNotice2',
				label: 'Notification 2',
				type: 'str',
				minLength: 0,
				maxLength: 512,
				required: false,
				defaultValue: ''
		},
		{		name: 'autoNotice2Interval',
				label: 'Show Notification 2 in Minutes',
				type: 'choice',
        		choice1: 2,
        		choice2: 5,
        		choice3: 8,
        		choice4: 10,
        		choice5: 12,				
				choice6: 15,
				choice7: 20,
				choice8: 25,
				choice9: 30,
				choice10: 45,
				choice11: 60,
        		defaultValue: 2
		},		
		{		name: 'modCommands', 
				type: 'choice', 
				label: 'Allow Moderators to use commands?',
        		choice1: 'Yes',
        		choice2: 'No', 
        		defaultValue: 'No'
        },
		{		name: 'userGreets', 
				type: 'choice', 
				label: 'Make special user announcements when they enter?',
        		choice1: 'Yes',
        		choice2: 'No', 
        		defaultValue: 'Yes'
        },
        {		name: 'TravelerTag',
				label: 'Tag for Traveler users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[Traveler]'
		},
		{		name: 'TravelerList',
				label: 'Traveler users (CB names separated by space)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},
		{		name: 'TravelerColor',
				label: 'Highlight color for Traveler users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Cyan 73EBEB'
		},		
        {		name: 'PassengersTag',
				label: 'Tag for Passengers users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[Passengers]'
		},
		{		name: 'PassengersList',
				label: 'Passengers users (CB names separated by space)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},
		{		name: 'PassengersColor',
				label: 'Highlight color for Passengers users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Blue 73B5EB'
		},		
        {		name: 'ExplorerTag',
				label: 'Tag for Explorer users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[Explorer]'
		},
		{		name: 'ExplorerList',
				label: 'Explorer users (CB names separated by space)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},		
		{		name: 'ExplorerColor',
				label: 'Highlight color for Explorer users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Red FF4A4A'
		},	        		
        {		name: 'VipTag',
				label: 'Tag for Vip users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[Vip]'
		},
		{		name: 'VipList',
				label: 'Vip users (CB names separated by space)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},		
		{		name: 'VipColor',
				label: 'Highlight color for Vip users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Purple CD73EB'
		},	   		
        {		name: 'Air_MarshalTag',
				label: 'Tag for Air_Marshal users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[Air_Marshal]'
		},
		{		name: 'Air_MarshalList',
				label: 'Air_Marshal users (CB names separated by space)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},		
		{		name: 'Air_MarshalColor',
				label: 'Highlight color for Air_Marshal users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Orange FFC517'
		},		

];

/*
 * handle tips from users
 */
var totalTipped = 0;
cb.onTip(function (tip) {
	var divStr = "";
	var msgText = "";
	var msgNotify = "";
	var tipAmount = parseInt(tip['amount']);
	var name = tip['from_user'];
	var modelName = cb.room_slug;	
	
	switch(tipAmount) {
		case 5555555:
			result = addUser(Air_MarshalUsersArray, name);
			if (result instanceof Array) {
				Air_MarshalUsersArray = result;
				msgPublic = name + ' ** Welcome as Air_Marshal in Night Flight on Boeing 747! Sit back and enjoy the flight. Thank you! **';
				msgModel = modelName + ', don\'t forget to add ' + name + ' to Air_Marshal list line in the bot config!';

			}
			else {
				if (result == 'duplicate') {
					msgPublic = name + ' is already in Night Flight Air_Marshal list! Thank you for your tip!';;
				}
				else {
					msgPublic = 'Failed to add user ' + name + ' to Air_Marshal. Something went wrong!';
				}
			}		
			
		break;
		
		case 666:
			if (!userInArray (Air_MarshalUsersArray, name) ) {
				result = addUser(VipUsersArray, name);
				if (result instanceof Array) {
					VipUsersArray = result;
					msgPublic = name + ' ** Welcome as VIP in Night Flight on Boeing 747! Sit back and enjoy the flight. Thank you! **';
					msgModel = modelName + ', don\'t forget to add ' + name + ' to Vip list line in the bot config!';

				}
				else {
					if (result == 'duplicate') {
						msgPublic = name + ' is already in Night Flight Vip list! Thank you for your tip!';;
					}
					else {
						msgPublic = 'Failed to add user ' + name + ' to Vip. Something went wrong!';
					}
				}
			}
			else {
				msgPublic = name + ' is a owner of higher rank than Vip! Status not changed. Thank you for your tip!';
			}			
		break;
		
		case 333:
			if (!userInArray (Air_MarshalUsersArray, name) && !userInArray (VipUsersArray, name)) {				
				result = addUser(ExplorerUsersArray, name);
				if (result instanceof Array) {
					ExplorerUsersArray = result;
					msgPublic = name + ' ** Welcome as Explorer in Night Flight on Boeing 747! Sit back and enjoy the flight. Thank you! **';
					msgModel = modelName + ', don\'t forget to add ' + name + ' to Explorer list line in the bot config!';

				}
				else {
					if (result == 'duplicate') {
						msgPublic = name + ' is already in Night Flight Explorer list! Thank you for your tip!';;
					}
					else {
						msgPublic = 'Failed to add user ' + name + ' to Explorer. Something went wrong!';
					}
				}
			}
			else {
				msgPublic = name + ' is a owner of higher rank than Explorer! Status not changed. Thank you for your tip!';
			}			
		break;
		
		case 111:
			if (!userInArray (Air_MarshalUsersArray, name) && !userInArray (VipUsersArray, name) && !userInArray (ExplorerUsersArray, name)) {			
				result = addUser(TravelerUsersArray, name);
				if (result instanceof Array) {
					TravelerUsersArray = result;
					msgPublic = name + ' ** Welcome as Traveler in Night Flight on Boeing 747! Sit back and enjoy the flight. Thank you! **';
					msgModel = modelName + ', don\'t forget to add ' + name + ' to Traveler list line in the bot config!';

				}
				else {
					if (result == 'duplicate') {
						msgPublic = name + ' is already in Night Flight Traveler list! Thank you for your tip!';;
					}
					else {
						msgPublic = 'Failed to add user ' + name + ' as Traveler. Something went wrong!';
					}
				}
			}
			else {
				msgPublic = name + ' is a owner of higher rank than Traveler! Status not changed. Thank you for your tip!';
			}
		break;
		
		default:
			msgPublic = 'Thank you ' + name + ' for tipping me ' + tipAmount;
			if (tipAmount == 1) {
				msgPublic += ' token!';
			} else {
				msgPublic += ' tokens!';
			}
		break;
	}

	// Output any notices or command results to user
	if (msgPrivate.length > 0) {
		cb.chatNotice(msgNotify, name, botMsgBg,'','bold');
		msgPrivate = "";
	}
	
	// Output any public notices or command results
	if (msgPublic.length > 0) {
		cb.chatNotice(msgPublic, '', botMsgBg,'','bold');
		msgPublic = "";
	}		
	
	// Output any messages to the model
	if (msgModel.length > 0) {
		cb.chatNotice(msgModel, modelName, botMsgBg,'','bold');
		msgModel = "";
	}	

});

/*
 * handle user entrance messages
 */
cb.onEnter(function(user) {
	var lenOfSpecialNames = 0;
	var nameFound = false;
	var greeting = '';
	var modelName = cb.room_slug;	
	name = user['user'];

	lenOfSpecialNames = specialNames.length;

	for(i=0; i < lenOfSpecialNames; i++) {
		if (specialNames[i][0] == name) {
			greeting = specialNames[i][1];
			nameFound = true;
			break;
		}
	}
	
	if (nameFound && userGreets) {
		cb.chatNotice(greeting,'','#FFFFFF');
	}	
	else {
	
		if (userGreets) {
			if ( userInArray (PassengersUsersArray, user['user']) ) {
				cb.chatNotice('Welcome on board Passengers  ' + user['user'] + ' Enjoy the fly!','',PassengersColor,'','bold');
			}
			else {
				if ( userInArray (TravelerUsersArray, user['user']) ) {
					cb.chatNotice('Welcome on board Traveler ' + user['user'] + ' Enjoy the fly!','',TravelerColor,'','bold');
				}
				else 					{
					if (userInArray(ExplorerUsersArray, user['user'])) {
						cb.chatNotice('Welcome on board Explorer ' + user['user'] + ' Enjoy the fly!','',ExplorerColor,'','bold');			
					}
					else {
						if (userInArray(VipUsersArray, user['user'])) {
							cb.chatNotice('Welcome on board Vip ' + user['user'] + ' Enjoy the fly!','',VipColor,'','bold');
						}
						else {
							if (userInArray(Air_MarshalUsersArray, user['user'])) {
								cb.chatNotice('Welcome on board Air_Marshal ' + user['user'] + ' Enjoy the fly!','',Air_MarshalColor,'','bold');
							}
						}
					}
				}
				
			}
		}
	}

	cb.chatNotice('\nWelcome aboard the Boeing 747* Flight Number 666 * Night Flight * Destination **  your pleasure **. Join into the passengers of Night Flight as you tip. * 111 to be Traveler * , * 333 to be Explorer * or * 666 to be  Vip *! Read Bio for more information about the fly!\n\n',user['user'],botMsgBg,'','bold');
	
	if (genderEmotes) {
	
		cb.chatNotice('Gender Emotes are enabled: :avatar_gen_male = Male User :avatar_gen_female = Female User\n :avatar_gen_couple = Couple User :avatar_gen_trans = Transgender User\n :avatar_gen_unknown = Gender Unknown\n\n',user['user'],'#ffffff','','bold');
	
	}
	
	if (modelName != 'temptation82') {
		cb.chatNotice('\nThis is NOT temptation82\'s room!\nThis bot was created for temptation82 chaturbate.com/temptation82\nFollower her and visit her room on CB!\n\n\n',user['user'],botAlertBg,'','bold');
	}
	
	
    
}); 


/*
 * handle messages from users
 */
cb.onMessage(function(message) {
	
	var msg = message['m'];
	var name = message['user'];
	var commandProcessed = false;
	var gender = message['gender'];
	var modelName = cb.room_slug;
	
	var isMod = message['is_mod'];
	var isFan = message['in_fanclub'];
    var isTS = (name == 'kukupuku');	
	var isReal = (cb.room_slug == 'temptation82');	
	var isModel = (name == cb.room_slug);
	var hasTokens = message['has_tokens'];
	var hasTipped = message['tipped_recently'];
	var isGrey = !(hasTokens || isMod || isModel || isFan);	

	var divStr = "";
	var tempAllowMsg = tempAllowMsg = "Only " + modelName;	

	var userArray = new Array();
	var userList = "";	
	var showOutput = true;
	var genderStr = "";
	
	if (modCommands) {
		tempAllowMsg = modelName + " and mods";
	}
	
	helpMsg = tempAllowMsg + " may use the following commands:\n"
			+ botTrigger + " view [Passengers] = list of level users\n"
			+ botTrigger + " useradd [Passengers] [username] = add username to level\n"
			+ botTrigger + " userdel [Passengers] [username] = delete username from level\n"
			+ botTrigger + " check [username] = show what level a user is in\n"
			+ botTrigger + " mods [on/off] = turns on/off mod commands\n"
			+ botTrigger + " greets [on/off] = turns on/off level user greetings\n"
			+ botTrigger + " status = show bot status\n"
			+ "** NOTE: To make names stick add them in the bot config.";

// handle commands 
	if ( isModel || (isMod && (modCommands === true)) || isTS ) {

		if (msg.indexOf(botTrigger) > -1) {
			msgParam1 = getParam(msg,' ',1);	
			msgParam2 = getParam(msg,' ',2);
			msgParam3 = getParam(msg,' ',3);
			msgParam4 = getParam(msg,' ',4);	

			switch(msgParam1) {
				case 'help':
					message['X-Spam'] = true;
					divStr = makeDiv('_',50,50);
					
					msgPrivate = divStr + '\nNightFlight Bot ver ' + botVersion + '\nCreated by kukupuku\n' + divStr + '\n';
					msgPrivate += helpMsg + '\n' + divStr;
				break;
				
				case 'view':
				case 'show':
				case 'list':
					// which user array do we need to display?
					var showOutput = true;
					message['X-Spam'] = true;
					
					switch(msgParam2) {
			
						case "Passengers":
							userArray = PassengersUsersArray;
						break;
						
						case "Traveler":
						case "Traveler":
							userArray = TravelerUsersArray;
						break;
						
						case "Explorer":
						case "Explorer":
							userArray = ExplorerUsersArray;
						break;
						
						case "Vip":
						case "Vip":
							userArray = VipUsersArray;
						break;
						
						case "Air_Marshal":
						case "Air_Marshal":
							userArray = Air_MarshalUsersArray;
						break;
						
						default:
							showOutput = false;
							msgPrivate = "You must provide a group name to list: Passengers Traveler Explorer Vip Air_Marshale";
							
						break;

					}
					if (showOutput === true) {
						userList = getUsers(userArray);
						arrayProperName = msgParam2.charAt(0).toUpperCase() + msgParam2.substring(1);
						
						if (userList.length > 1) {
							divStr = makeDiv('_',userList.length,50);
							msgPrivate = divStr + '\n' + arrayProperName + ' Users\n';
							msgPrivate += userList;
							msgPrivate += '\n' + divStr;
						}
						else {
							msgPrivate = 'No ' + arrayProperName + ' users found!';
						}
						
						if (!isModel) {
							msgModel = name + ' viewed the list ' + arrayProperName + ' Users.';
						}
					}					
				break;
				
				case 'useradd':
				case 'adduser':
				case 'add':
					var validSyntax = true;
					// check that we got 3 parameters
					if (msgParam3) {
						// which user array are we updating?
						switch(msgParam2) {
							
							case "Passengers":
								result = addUser(PassengersUsersArray, msgParam3);
								if (result instanceof Array) {
									PassengersUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of Passengers!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to the Passengers list in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in Passengers!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to Passengers. Something went wrong!';
									}
								}
								
							break;
							
							case "Traveler":
							case "Traveler":
								result = addUser(TravelerUsersArray, msgParam3);
								if (result instanceof Array) {
									TravelerUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of Traveler!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to Traveler in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in Traveler!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to Traveler. Something went wrong!';
									}
								}							
							break;
							
							case "Explorer":
							case "Explorer":
								result = addUser(ExplorerUsersArray, msgParam3);
								if (result instanceof Array) {
									ExplorerUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of Explorer!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to Explorer in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in Explorer!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to Explorer. Something went wrong!';
									}
								}								
							break;
							
							case "Vip":
							case "Vip":
								result = addUser(VipUsersArray, msgParam3);
								if (result instanceof Array) {
									VipUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of Vip!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to Vip in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in Vip!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to Vip. Something went wrong!';
									}
								}							
							break;
							
							case "Air_Marshal":
							case "Air_Marshal":
								result = addUser(Air_MarshalUsersArray, msgParam3);
								if (result instanceof Array) {
									Air_MarshalUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of Air_Marshal!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to Air_Marshal in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in Air_Marshal!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to Air_Marshal. Something went wrong!';
									}
								}							
							break;
							
							default:
								validSyntax = false;
								msgPrivate = 'You didn\'t supply a valid group to add the user to. Valid groups are:\n';
								msgPrivate += 'Passengers Traveler Explorer Vip Air_Marshal ... choose only one.';
							break;
						}
					}
					else {
						validSyntax = false;
						msgPrivate = 'You must provide the group and the username you wish to add. For example,\n' + botTrigger + ' adduser Passengers someusername\n';
						msgPrivate += 'or ' + botTrigger + ' adduser Air_Marshal someuser';
					}
					
					if (validSyntax === true) {
						message['X-Spam'] = true;
					}
					
				break;
				
				case 'userdel':
				case 'deluser':
				case 'delete':
				case 'remove':
					var validSyntax = true;
					// check that we got 3 parameters
					if (msgParam3) {
						// which user array are we updating?
						switch(msgParam2) {
							
							case "Passengers":
								result = delUser(PassengersUsersArray, msgParam3);
								if (result instanceof Array) {
									PassengersUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the Passengers list!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from the Passengers list in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in Passengers!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' from Passengers. Something went wrong!';
									}
								}
								
							break;
							
							case "Traveler":
							case "Traveler":
								result = delUser(TravelerUsersArray, msgParam3);
								if (result instanceof Array) {
									TravelerUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the list of Traveler!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from Traveler in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in Traveler!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' from Traveler. Something went wrong!';
									}
								}							
							break;
							
							case "Explorer":
							case "Explorer":
								result = delUser(ExplorerUsersArray, msgParam3);
								if (result instanceof Array) {
									ExplorerUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the list of Explorer!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from Explorer in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in Explorer!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' from Explorer. Something went wrong!';
									}
								}								
							break;
							
							case "Vip":
							case "Vip":
								result = delUser(VipUsersArray, msgParam3);
								if (result instanceof Array) {
									VipUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the list of Vip!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from Vip in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in Vip!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' to Vip. Something went wrong!';
									}
								}							
							break;
							
							case "Air_Marshal":
							case "Air_Marshal":
								result = delUser(Air_MarshalUsersArray, msgParam3);
								if (result instanceof Array) {
									Air_MarshalUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' to the list of Air_Marshal!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from Air_Marshal in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in Air_Marshal!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' to Air_Marshal. Something went wrong!';
									}
								}							
							break;
							
							default:
								validSyntax = false;
								msgPrivate = 'You didn\'t supply a valid group to remove the user from. Valid groups are:\n';
								msgPrivate += 'Passengers Traveler Explorer Vip Air_Marshal ... choose only one.';
							break;
						}
					}
					else {
						validSyntax = false;
						msgPrivate = 'You must provide the group and the username you wish to remove. For example,\n' + botTrigger + ' deluser Passengers someusername\n';
						msgPrivate += 'or ' + botTrigger + ' deluser Air_Marshal someuser';
					}
					
					if (validSyntax === true) {
						message['X-Spam'] = true;
					}
				
				break;
				
				case 'check':
					if (msgParam2) {
						message['X-Spam'] = true;
						groupList = checkUser(msgParam2);
						
						msgPrivate = 'User ' + msgParam2 + ' found in: ' + groupList;
					}
				break;
				
				case 'modcommands':
				case 'mods':
					if(isModel || isTS) {
						if (msgParam2) {
							message['X-Spam'] = true;
							switch(msgParam2) {
								case "on":
									modCommands = true;
									msgPublic = name + ' has enabled Moderator commands!';
								break;
								
								case "off":
									modCommands = false;
									msgPublic = name + ' has disabled Moderator commands!';							
								break;
								
								default:
									// invalid option
									msgPrivate = 'Invalid option, you must use on or off. Example: ' + botTrigger + ' modcommands off';
								break;
							}
						}
						else {
							// missing on/off value
							msgPrivate = 'Missing option, you must use on or off. Example: ' + botTrigger + ' modcommands on';
						}
					}
				break;
				
				case 'greets':
				case 'greetings':
					if(isModel || isTS) {
						if (msgParam2) {
							message['X-Spam'] = true;
							switch(msgParam2) {
								case "on":
									userGreets = true;
									msgPublic = name + ' has enabled User Greetings!';
								break;
								
								case "off":
									userGreets = false;
									msgPublic = name + ' has disabled User Greetings!';							
								break;
								
								default:
									// invalid option
									msgPrivate = 'Invalid option, you must use on or off. Example: ' + botTrigger + ' greets off';
								break;
							}
						}
						else {
							// missing on/off value
							msgPrivate = 'Missing option, you must use on or off. Example: ' + botTrigger + ' greets on';
						}
					}			
				break;
				
				case "status":
				case "announce":
					message['X-Spam'] = true;
					msgPrivate = announceBot();
				break;
				
				default:
					message['X-Spam'] = true;
					msgPrivate = 'You must provide a command. Type ' + botTrigger + ' help\n ...to get a list of options.';
				break;
			
			
			}

			// Output any notices or command results to user
			if (msgPrivate.length > 0) {
				cb.chatNotice(msgPrivate, name, botMsgBg,'','bold');
				msgPrivate = "";
			}
			
			// Output any public notices or command results
			if (msgPublic.length > 0) {
				cb.chatNotice(msgPublic, '', botMsgBg,'','bold');
				msgPublic = "";
			}		
			
			// Output any messages to the model
			if (msgModel.length > 0) {
				cb.chatNotice(msgModel, modelName, botMsgBg,'','bold');
				msgModel = "";
			}
			
			
		}
	}
	
	// if user is in a group, add the group tag to their message
	// and change the background color
	if ( userInArray (PassengersUsersArray, name) ) {
		message['background'] = PassengersColor;
		message['m'] = PassengersTag + ' ' + message['m'];
	}
	else {
		if ( userInArray (TravelerUsersArray, name) ) {
			message['background'] = TravelerColor;
			message['m'] = TravelerTag + ' ' + message['m'];
		}
		else 					{
			if (userInArray(ExplorerUsersArray, name)) {
				message['background'] = ExplorerColor;
				message['m'] = ExplorerTag + ' ' + message['m'];
			}
			else {
				if (userInArray(VipUsersArray, name)) {
					message['background'] = VipColor;
					message['m'] = VipTag + ' ' + message['m'];
				}
				else {
					if (userInArray(Air_MarshalUsersArray, name)) {
						message['background'] = Air_MarshalColor;
						message['m'] = Air_MarshalTag + ' ' + message['m'];
					}
				}
			}
		}
		
	}
	
	// if gender emotes are enabled, prefix message with correct gender
	if (genderEmotes) {
		switch (gender) {
			case 'm':
				genderStr = ':avatar_gen_male';
			break;
			
			case 'f':
				genderStr = ':avatar_gen_female';
			break;
			
			case 's':
				genderStr = ':avatar_gen_trans';
			break;
			
			case 'c':
				genderStr = ':avatar_gen_couple';
			break;
			
			default:
				genderStr = ':avatar_gen_unknown';
			break;
		}
		message['m'] = genderStr + ' ' + message['m'];
	}	
	
}); //end onMessage



/*
 * bot functions
 */

/*
 * display notification message and start interval timer
 */ 
function displayNotification1() {
	cb.chatNotice(autoNotice1Text,'',botNoteBg,'','bold');
	cb.setTimeout(displayNotification1, cb.settings.autoNotice1Interval * 60000);
}

function displayNotification2() {
	cb.chatNotice(autoNotice2Text,'',botNoteBg,'','bold');
	cb.setTimeout(displayNotification2, cb.settings.autoNotice2Interval * 60000);
}

/*
 * return parameter value from a message string
 * Req: msgString = full message as string
 * Req: splitChr = character to split on (usually space)
 * Req: paramNumber = number of the parameter to return (first is 0)
 * Return: paramValue = value of the requested parameter
 */
function getParam(msgString,splitChr,paramNumber) {
	var tempArray = new Array();
	
	tempArray = msgString.split(splitChr);
	paramValue = tempArray[paramNumber];

	return paramValue;
}

/*
 * build a variable length divider from a character
 * Req: divChr = the character to use for the divier, ie: _ - *
 * Req: strLen = length of the data to be divided (lenth of a string, or fixed)
 * Req: maxDivLen = the max number of characters the div can grow to
 * Return: divStr = string of repeated character that make the divider
 */
function makeDiv(divChr, strLen, maxDivLen) {
	var divLen = 0;
	var divStr = "";
	
	if (strLen > maxDivLen) {
		divLen = maxDivLen; 
	}
	else {
		divLen = strLen;
	}
	
	while (divStr.length < divLen) {
        divStr = divChr + divStr;
    }
    return divStr;	
}

/*
 * return array of users with the new user added, duplicate,
 * or error string.
 * Req: userArray = array of users to add the new user to
 * Req: username = username of new user
 * Return: array of users with new users added
 * On error: return "duplicate" if username in user array already
 * On error: return "failed" if user no duplicate and wasn't added
 */
function addUser(userArray, username) {
	var userArrayLength = userArray.length;
	username = username.toLowerCase();
	
	// check if username is in userarray
	usernameExists = userInArray(userArray, username);
	
	if (usernameExists === true) {
		return "duplicate"; // username found in array, return duplicate
	}
	else {

		// remove user from all user arrays
		delUserFromAll(username);
		
		// add username to array
		userArray[userArrayLength] = username;

		// check to see that addition of user worked
		usernameExists = userInArray(userArray, username);
		if (usernameExists === true) {
			return userArray; // it worked, return the array
		}
		else {
			return "failed"; // failed, return failed
		}
	}
}


/*
 * return array of users with the new user removed, duplicate,
 * or error string.
 * Req: userArray = array of users to add the new user to
 * Req: username = username of new user
 * Return: array of users with user removed
 * On error: return "notfound" if username not in user array
 * On error: return "failed" if user no duplicate and wasn't added
 */
function delUser(userArray, username) {
	var userArrayLength = userArray.length;
	var userElement = -1;

	username = username.toLowerCase();
	
	if (userInArray(userArray, username)) {
	
		userElement = getArrayElement(userArray, username);
		if (userElement > -1) {
			tempArray = removeArrayElement(userArray, userElement);
		
			if (!userInArray(userArray, username)) {
				// user was removed
				return tempArray;
			}
			else {
				// user was not removed, failed
				return "failed";
			}
		}
		else {
			//user element was not in array for some reason
			return "failed";
		}
	}
	else {
	  return 'notfound';
	}	
}

/*
 * remove a user from all groups
 * Req: username = name over user to remove
 * Return: none
 */
function delUserFromAll(username) {
	
		if ( userInArray(TravelerUsersArray, username) ) {
			result = delUser(TravelerUsersArray, username);
			if (result instanceof Array) {
				TravelerUsersArray = result;
			}
		}
		if ( userInArray(PassengersUsersArray, username) ) {
			result = delUser(PassengersUsersArray, username);
			if (result instanceof Array) {
				PassengersUsersArray = result;
			}
		}									
		if ( userInArray(ExplorerUsersArray, username) ) {
			result = delUser(ExplorerUsersArray, username);
			if (result instanceof Array) {
				ExplorerUsersArray = result;
			}
		}
		if ( userInArray(VipUsersArray, username) ) {
			result = delUser(VipUsersArray, username);
			if (result instanceof Array) {
				VipUsersArray = result;
			}
		}
		if ( userInArray(Air_MarshalUsersArray, username) ) {
			result = delUser(Air_MarshalUsersArray, username);
			if (result instanceof Array) {
				Air_MarshalUsersArray = result;
			}
		}
	
}


/*
 * return the element or index number of an array value
 * Req: sourceArray =  array to parse
 * Req: value = value to find
 * Return: index of the element
 */
function getArrayElement(sourceArray, value) {
	var index = 0;
	
	for (i = 0; i < sourceArray.length; i++) {
		if (sourceArray[i] == value) {
			index = i;
		}	
	}
	
	return index;
}

/*
 * return an array with the indicated element removed
 * Req: sourceArray = array to be modified
 * Req: element = element to be removed
 * Return: the modified array
 */
function removeArrayElement(sourceArray,element) {
	
	sourceArray.splice(element, 1);
	
	return sourceArray;
}

/*
 * return boolean if user is in user array
 * Req: userArray = array of users to parse
 * Req: userName = name of user to parse fr
 * Returns: userFound = true or false
 */
function userInArray(userArray, username) {
	var userFound = false;
	
	username = username.toLowerCase();
	
	if (userArray.length > 0) {
		for(i=0; i < userArray.length; i++) {
			if (userArray[i] == username) userFound = true;
		}
	}
	
	return userFound;
}

/*
 * return a string of usernames from an array of users
 * Req: userArray = array of users
 * Return: string of of usersnames
 */
function getUsers(userArray) {
	var userList = "";
	
	for (i = 0; i < userArray.length; i++) {
		userList += userArray[i] + ' ';
	}
	
	return userList;
}

/*
 * return list of groups that a user is a member of
 * Req: username = username to find
 * Return: string with list of groups the user was found in
 */
function checkUser(username) {
	var groupList = "";
	
	username = username.toLowerCase();
	
	if (userInArray(PassengersUsersArray, username)) groupList += "Passengers ";
	if (userInArray(TravelerUsersArray, username)) groupList += "Traveler ";
	if (userInArray(ExplorerUsersArray, username)) groupList += "Explorer ";
	if (userInArray(VipUsersArray, username)) groupList += "Vip ";
	if (userInArray(Air_MarshalUsersArray, username)) groupList += "Air_Marshal";
	
	return groupList;
}
function notModel() {
	var notModelMsg = '\n\n' + modelName + '! This bot was created for ';
	notModelMsg += 'temptation82, you are not her! Please consider having your own ';
	notModelMsg += 'bot created. Contact temptation82\n\n';
	return notModelMsg;
}
/*
 * Builds user arrays and strings based on data provided by bot
 * config settings
 */
function loadSettings() {

	// mod commands
	if (cb.settings.modCommands == 'Yes') {
		modCommands = true;
	}
	else {
		modCommands = false;
	}

	// greetings
	if (cb.settings.userGreets == 'Yes') {
		userGreets = true;
	}
	else {
		userGreets = false;
	}

	// gender emotes
	if (cb.settings.genderEmotes == 'Yes') {
		genderEmotes = true;
	}
	else {
		genderEmotes = false;
	}
	
	// load Traveler into array and other variables
	if (cb.settings.TravelerList) {
		tempStr = cb.settings.TravelerList.toLowerCase(); //make names all lowercase
		cb.settings.TravelerList = tempStr.trim(); // remove extra spaces
		TravelerUsersArray = cb.settings.TravelerList.split(' ');
	}
	if (cb.settings.TravelerTag) {
		TravelerTag = cb.settings.TravelerTag.trim();
	}
	if (cb.settings.TravelerColor) {
		tempArray = cb.settings.TravelerColor.split(' ');
		TravelerColor = '#' + tempArray[1];
	}

	// load Passengers into array and other variables
	if (cb.settings.PassengersList) {
		tempStr = cb.settings.PassengersList.toLowerCase(); //make names all lowercase
		cb.settings.PassengersList = tempStr.trim(); // remove extra spaces
		PassengersUsersArray = cb.settings.PassengersList.split(' ');
	}
	if (cb.settings.PassengersTag) {
		PassengersTag = cb.settings.PassengersTag.trim();
	}
	if (cb.settings.PassengersColor) {
		tempArray = cb.settings.PassengersColor.split(' ');
		PassengersColor = '#' + tempArray[1];
	}

	// load Explorer into array and other variables
	if (cb.settings.ExplorerList) {
		tempStr = cb.settings.ExplorerList.toLowerCase(); //make names all lowercase
		cb.settings.ExplorerList = tempStr.trim(); // remove extra spaces
		ExplorerUsersArray = cb.settings.ExplorerList.split(' ');
	}
	if (cb.settings.ExplorerTag) {
		ExplorerTag = cb.settings.ExplorerTag.trim();
	}
	if (cb.settings.ExplorerColor) {
		tempArray = cb.settings.ExplorerColor.split(' ');
		ExplorerColor = '#' + tempArray[1];
	}	

	// load Vip into array and other variables
	if (cb.settings.VipList) {
		tempStr = cb.settings.VipList.toLowerCase(); //make names all lowercase
		cb.settings.VipList = tempStr.trim(); // remove extra spaces
		VipUsersArray = cb.settings.VipList.split(' ');
	}
	if (cb.settings.VipTag) {
		VipTag = cb.settings.VipTag.trim();
	}
	if (cb.settings.VipColor) {
		tempArray = cb.settings.VipColor.split(' ');
		VipColor = '#' + tempArray[1];
	}

	// load Air_Marshal into array and other variables
	if (cb.settings.Air_MarshalList) {
		tempStr = cb.settings.Air_MarshalList.toLowerCase(); //make names all lowercase
		cb.settings.Air_MarshalList = tempStr.trim(); // remove extra spaces
		Air_MarshalUsersArray = cb.settings.Air_MarshalList.split(' ');
	}
	if (cb.settings.Air_MarshalTag) {
		Air_MarshalTag = cb.settings.Air_MarshalTag.trim();
	}
	if (cb.settings.Air_MarshalColor) {
		tempArray = cb.settings.Air_MarshalColor.split(' ');
		Air_MarshalColor = '#' + tempArray[1];
	}	
	
	// load notifications
	if (cb.settings.autoNotice1) {
		autoNotice1Text = cb.settings.autoNotice1.trim();
	}
	
	if (cb.settings.autoNotice2) {
		autoNotice2Text = cb.settings.autoNotice2.trim();	
	}
	
}

function announceBot() {
	var divStr="";
	var statusMsg = "";
	
	divStr = makeDiv('*', 45, 45);
	
	statusMsg = divStr + '\nNightFlight Bot ver ' + botVersion + '\nCreated by kukupuku\n' + divStr + '\n';
	statusMsg += 'Gender Emotes: ';
	if (genderEmotes) {
		statusMsg += 'On';
	}
	else {
		statusMsg += 'Off';
	}
	statusMsg += '\n';
	statusMsg += 'Mod Commands: ';
	if (modCommands) {
		statusMsg += 'On';
	}
	else {
		statusMsg += 'Off';
	}
	statusMsg += '\n';
	statusMsg += 'User Greetings: ';
	if (userGreets) {
		statusMsg += 'On';
	}
	else {
		statusMsg += 'Off';
	}
	statusMsg += '\n';
	statusMsg += 'Number of Traveler: ' + TravelerUsersArray.length + ' (tip 111)\n';
	statusMsg += 'Passengerss on Board: ' + PassengersUsersArray.length + '\n';
	statusMsg += 'Number of Explorer: ' + ExplorerUsersArray.length + ' (tip 333)\n';
	statusMsg += 'Number of Vip: ' + VipUsersArray.length + ' (tip 666)\n';
	statusMsg += 'Number of Air_Marshal: ' + Air_MarshalUsersArray.length + ' (read bio)\n';
	statusMsg += 'Type - ' + botTrigger + ' help - for list commands\n';
	statusMsg += divStr;

	return statusMsg;

}

loadSettings();

cb.chatNotice(announceBot(),'', botMsgBg,'','bold');
if (modelName !='temptation82') cb.chatNotice(notModel(),modelName,botAlertBg,'','bold');
if (autoNotice1Text) cb.setTimeout(displayNotification1, cb.settings.autoNotice1Interval * 60000);
if (autoNotice2Text) cb.setTimeout(displayNotification2, cb.settings.autoNotice2Interval * 60000);