dsrc/sku.0/sys.server/compiled/game/script/library/tcg.scriptlib

/***** INCLUDES ********************************************************/
include library.beast_lib;
include library.incubator;
include library.spawning;
include library.static_item;
include library.target_dummy;
include library.utils;

//LOGGING
const boolean LOGGING_ON				= false;
const string LOGGING_CATEGORY				= "tcg_barn";

//BARN AND RANCH HAND
const string RANCHHAND_CELL_SCRIPT			= "systems.tcg.barn_cell";

const string RANCHHAND_PREFIX 				= "ranchhand";
const string RANCHHAND_CELLCHECK 			= RANCHHAND_PREFIX + ".ranchhandcheck";
const string RANCHHAND_CELL	 			= RANCHHAND_PREFIX + ".ranchhandcell";
const string RANCHHAND_STRUCTURE 			= RANCHHAND_PREFIX + ".structure";
const string RANCHHAND_OBJECT	 			= RANCHHAND_PREFIX + ".ranchhand_object";

const string RANCH_HAND_TEMPLATE 			= "object/tangible/tcg/series1/structure_barn_ranchhand.iff";
const string CELL_NAME 					= "entry";
const string BEAST_ROAMING				= "beast_roaming";

const float RANCH_HAND_X				= 4.2f;
const float RANCH_HAND_Y				= 0.0f;
const float RANCH_HAND_Z				= 2.7f;
const float RANCH_HAND_HEADING				= 172.0f;


/**********************************************************************/
/***** Barn functions *************************************************/

const string BARN_STRUCTURE_TEMPLATE = "object/building/player/city/barn_no_planet_restriction.iff";
const string BARN_RANCHHAND_SCRIPT	= "systems.tcg.barn_ranchhand";
const string BARN_BEAST_SCRIPT	= "systems.tcg.barn_beast";

const int MAX_NUM_BARN_PETS		= 40;

const int DEFAULT_NUM_BARN_LITE_PETS	= 5;

const string[] BEAST_OBJVARS	= 
{
	"beast",
	"beastmood",
	"abilities"
};

//TCG Mahjong Game Objvars
const int MAX_NUMBER_OF_HIGH_SCORES 		= 5;
const int EST_MAX_SCORE		 		= 626;
const string TABLE_OBJVAR_PREFIX 		= "minigame_table";
const string TABLE_HIGHSCORE_SLOTS 		= TABLE_OBJVAR_PREFIX + ".highscores";

const float[] DEFAULT_HIGH_SCORE_MODIFIER 	= 
{
	0.30f,
	0.31f,
	0.32f,
	0.33f,
	0.34f,
	0.35f,
	0.36f	
};

const string[] DEFAULT_HIGH_SCORE_LIST		=
{
	"Valara",
	"DevH",
	"Loche",
	"Millbarge",
	"Jaskell",
	"AdeptStrain",
	"Cheeseplus",
	"Swede",
	"Blixtev",
	"DeadMeat",
	"CancelAutoRun",
	"Dotanuki",
	"Tereb",
	"Hanse",
	"Teesquared",
	"Valara",
	"DevH",
	"Loche",
	"Millbarge",
	"Jaskell",
	"AdeptStrain",
	"Cheeseplus",
	"Swede",
	"Blixtev",
	"DeadMeat",
	"CancelAutoRun",
	"Dotanuki",
	"Tereb",
	"Hanse",
	"Teesquared"
};

boolean isBarnRanchhand(obj_id target)
{
	if ( hasScript(target, BARN_RANCHHAND_SCRIPT) )
	{
		return true;
	}

	return false;
}

boolean isBarnStructure(obj_id building)
{
	string template = getTemplateName(building);
	if ( template.equals(BARN_STRUCTURE_TEMPLATE) )
	{
		return true;
	}
	return false;
}

void barnStoreBeastPrompt(obj_id player, obj_id ranchhand)
{
	obj_id barn = getTopMostContainer(ranchhand);
	if ( isBarnLiteDevice(ranchhand) )
	{
		barn = ranchhand;
	}
	if ( !isIdValid(barn) )
	{
		return;
	}

	obj_id[] initialBcdsList = beast_lib.getDatapadBCDs(player);
	if ( initialBcdsList == null || initialBcdsList.length < 1 )
	{
		sendSystemMessage(player, new string_id("tcg", "barn_no_beast_control_devices_found"));
	}
	else
	{
		resizeable obj_id[] vectorBcdsList = new obj_id[0];
		resizeable string[] vectorBeastNames = new string[0];
		for ( int i = 0; i < initialBcdsList.length; i++  )
		{
			obj_id bcd = initialBcdsList[i];
			string beastName = beast_lib.getBCDBeastName(bcd);
			if ( beastName != null && beastName.length() > 0 )
			{
				utils.addElement(vectorBeastNames, toUpper(beastName, 0));
				utils.addElement(vectorBcdsList, bcd);
			}
		}

		if ( vectorBeastNames != null && vectorBcdsList != null && vectorBeastNames.length > 0 && vectorBcdsList.length > 0 )
		{
			obj_id[] finalBcdsList = utils.toStaticObjIdArray(vectorBcdsList);
			string[] finalBeastNames = utils.toStaticStringArray(vectorBeastNames);

			int currentNumStored = getTotalBarnStoredBeasts(barn);

			string promptRef = "";
			string promptExtra = target_dummy.addLineBreaks(2);
			if ( isBarnLiteDevice(ranchhand) )
			{
				promptRef = "barn_lite_beast_selection_storage_prompt";
				promptExtra += "Number of Beasts in the Beast Storage Device: "+currentNumStored+" of "+getMaxBarnLiteBeasts(ranchhand);
			}
			else
			{
				promptRef = "barn_beast_selection_storage_prompt";
				promptExtra += "Number of Beasts in the Barn: "+currentNumStored+" of "+MAX_NUM_BARN_PETS;
			}

			barnSelectPlayerBeastSui(player, ranchhand, finalBcdsList, finalBeastNames, promptRef, promptExtra, "handleBarnBeastStorage");
		}
	}
	return;
}

void barnSelectPlayerBeastSui(obj_id player, obj_id ranchhand, obj_id[] beastControlDevices, string[] beastNames, string promptRef, string promptExtra, string handler)
{
	// Force closed any previous version of the sui
	if ( utils.hasScriptVar(player, "barnRanchHand.pid") )
	{
		int oldPid = utils.getIntScriptVar(player, "barnRanchHand.pid");
		forceCloseSUIPage(oldPid);
		utils.removeScriptVar(player, "barnRanchHand.pid");
	}

	// clean up any script vars from previous usage
	if ( utils.hasScriptVar(player, "barnRanchHand."+handler) )
	{
		utils.removeScriptVar(player, "barnRanchHand."+handler);
	}

	// alphabetize beast lists
	string[] alphabetizedBeastNames = new string[beastNames.length];
	obj_id[] sortedBeastControlDevices = new obj_id[beastControlDevices.length];

	utils.copyArray(beastNames, alphabetizedBeastNames);
	Arrays.sort(alphabetizedBeastNames);
	for ( int j = 0; j < alphabetizedBeastNames.length; j++ )
	{
		string alphabetizedName = alphabetizedBeastNames[j];
		int index = utils.getElementPositionInArray(beastNames, alphabetizedName);
		obj_id sortedBeast = beastControlDevices[index];

		sortedBeastControlDevices[j] = sortedBeast;
		beastNames[index] = "_";
	}
	// end alphabetize

	string title = utils.packStringId(new string_id("tcg", "barn_beast_selection_title"));
	string prompt = utils.packStringId(new string_id("tcg", promptRef));
	if ( promptExtra != null && promptExtra.length() > 0 )
	{
		prompt += promptExtra;
	}

	int pid = sui.listbox(ranchhand, player, prompt, sui.OK_CANCEL, title, alphabetizedBeastNames, handler);

	if ( pid > -1 )
	{
		utils.setScriptVar(player, "barnRanchHand.pid", pid);
		utils.setScriptVar(player, "barnRanchHand."+handler, sortedBeastControlDevices);
	}
	return;
}

void barnReclaimBeastPrompt(obj_id player, obj_id barn, obj_id ranchhand)
{
	string[] initialStorageList = getBarnBeastStorageSlots(barn);
	if ( initialStorageList == null || initialStorageList.length < 1 )
	{
		sendSystemMessage(player, new string_id("tcg", "barn_no_beast_control_devices_found"));
	}
	else
	{
		resizeable string[] vectorBcdsList = new string[0];
		resizeable string[] vectorBeastNames = new string[0];
		for ( int i = 0; i < initialStorageList.length; i++  )
		{
			string bcdSlot = initialStorageList[i];
			string beastName = "";
			if ( hasObjVar(barn, "barnStorage."+bcdSlot+".beast.beastName") )
			{
				beastName =getStringObjVar(barn, "barnStorage."+bcdSlot+".beast.beastName");
			}
			else if ( hasObjVar(barn, "barnStorage."+bcdSlot+".tempName") )
			{
				beastName = getStringObjVar(barn, "barnStorage."+bcdSlot+".tempName");
			}
			if ( beastName != null && beastName.length() > 0 )
			{
				utils.addElement(vectorBeastNames, toUpper(beastName, 0));
				utils.addElement(vectorBcdsList, bcdSlot);
			}
		}

		if ( vectorBeastNames != null && vectorBcdsList != null && vectorBeastNames.length > 0 && vectorBcdsList.length > 0 )
		{
			string[] finalBcdsList = utils.toStaticStringArray(vectorBcdsList);
			string[] finalBeastNames = utils.toStaticStringArray(vectorBeastNames);

			string promptExtra = target_dummy.addLineBreaks(2);
			if ( isBarnLiteDevice(ranchhand) )
			{
				promptExtra += "Number of Beasts in the Beast Storage Device: "+getTotalBarnStoredBeasts(barn)+" of "+getMaxBarnLiteBeasts(barn);
			}
			else
			{
				promptExtra += "Number of Beasts in the Barn: "+getTotalBarnStoredBeasts(barn)+" of "+MAX_NUM_BARN_PETS;
			}

			barnSelectStoredBeastSui(player, ranchhand, finalBcdsList, finalBeastNames, "barn_beast_selection_reclaim_prompt", promptExtra, "handleBarnBeastReclaim");
		}
	}
	return;
}

void barnDisplayBeastPrompt(obj_id player, obj_id barn, obj_id ranchhand)
{
	string[] initialStorageList = getBarnBeastStorageSlots(barn);
	if ( initialStorageList == null || initialStorageList.length < 1 )
	{
		sendSystemMessage(player, new string_id("tcg", "barn_no_beast_control_devices_found"));
	}
	else
	{
		resizeable string[] vectorBcdsList = new string[0];
		resizeable string[] vectorBeastNames = new string[0];
		for ( int i = 0; i < initialStorageList.length; i++  )
		{
			string bcdSlot = initialStorageList[i];
			string beastName = "";
			if ( hasObjVar(barn, "barnStorage."+bcdSlot+".beast.beastName") )
			{
				beastName =getStringObjVar(barn, "barnStorage."+bcdSlot+".beast.beastName");
			}
			else if ( hasObjVar(barn, "barnStorage."+bcdSlot+".tempName") )
			{
				beastName = getStringObjVar(barn, "barnStorage."+bcdSlot+".tempName");
			}

			if (hasObjVar(barn, "barnStorage."+bcdSlot+"."+BEAST_ROAMING))//Display var

			{
				beastName = beastName + " [Displayed]";
			}
			else
			{
				beastName = beastName + " [Stored]";
			}

			if ( beastName != null && beastName.length() > 0 )
			{
				utils.addElement(vectorBeastNames, toUpper(beastName, 0));
				utils.addElement(vectorBcdsList, bcdSlot);
			}
		}

		string prompt = "barn_beast_selection_display_prompt";
		if ( isBarnLiteDevice(ranchhand) )
		{
			prompt = "barn_lite_beast_selection_display_prompt";
		}

		if ( vectorBeastNames != null && vectorBcdsList != null && vectorBeastNames.length > 0 && vectorBcdsList.length > 0 )
		{
			string[] finalBcdsList = utils.toStaticStringArray(vectorBcdsList);
			string[] finalBeastNames = utils.toStaticStringArray(vectorBeastNames);
			barnSelectStoredBeastSui(player, ranchhand, finalBcdsList, finalBeastNames, prompt, "", "handleBarnBeastDisplay");
		}
	}
	return;
}

void barnSelectStoredBeastSui(obj_id player, obj_id ranchhand, string[] beastControlSlots, string[] beastNames, string promptRef, string promptExtra, string handler)
{
	// Force closed any previous version of the sui
	if ( utils.hasScriptVar(player, "barnRanchHand.pid") )
	{
		int oldPid = utils.getIntScriptVar(player, "barnRanchHand.pid");
		forceCloseSUIPage(oldPid);
		utils.removeScriptVar(player, "barnRanchHand.pid");
	}

	// clean up any script vars from previous usage
	if ( utils.hasScriptVar(player, "barnRanchHand."+handler) )
	{
		utils.removeScriptVar(player, "barnRanchHand."+handler);
	}

	// alphabetize beast lists
	string[] alphabetizedBeastNames = new string[beastNames.length];
	string[] sortedBeastControlSlots = new string[beastControlSlots.length];

	utils.copyArray(beastNames, alphabetizedBeastNames);
	Arrays.sort(alphabetizedBeastNames);
	for ( int j = 0; j < alphabetizedBeastNames.length; j++ )
	{
		string alphabetizedName = alphabetizedBeastNames[j];
		int index = utils.getElementPositionInArray(beastNames, alphabetizedName);
		string sortedBeast = beastControlSlots[index];

		sortedBeastControlSlots[j] = sortedBeast;
		beastNames[index] = "_";
	}
	// end alphabetize

	string title = utils.packStringId(new string_id("tcg", "barn_beast_selection_title"));
	string prompt = utils.packStringId(new string_id("tcg", promptRef));
	if ( promptExtra != null && promptExtra.length() > 0 )
	{
		prompt += promptExtra;
	}

	int pid = sui.listbox(ranchhand, player, prompt, sui.OK_CANCEL, title, alphabetizedBeastNames, handler);

	if ( pid > -1 )
	{
		utils.setScriptVar(player, "barnRanchHand.pid", pid);
		utils.setScriptVar(player, "barnRanchHand."+handler, sortedBeastControlSlots);
	}
	return;
}

boolean transferBeastControlDeviceToBarn(obj_id selectedBeastControlDevice, obj_id player, obj_id barn)
{
	string nextAvailableStorageSlot = getNextAvailableBarnStorageSlot(barn, player);
	if ( nextAvailableStorageSlot != null && nextAvailableStorageSlot.length() > 0 )
	{
		string bcdTemplate = getTemplateName(selectedBeastControlDevice);
		if ( bcdTemplate != null && bcdTemplate.length() > 0 )
		{
			setObjVar(barn, nextAvailableStorageSlot+".bcdTemplate", bcdTemplate);
			if ( !hasObjVar(selectedBeastControlDevice, "beast.beastName") )
			{
				setObjVar(barn, nextAvailableStorageSlot+".tempName", beast_lib.getBeastLocalizedName(selectedBeastControlDevice));
			}

			for ( int i = 0; i < BEAST_OBJVARS.length; i++ )
			{
				string beastObjvar = BEAST_OBJVARS[i];
				if ( hasObjVar(selectedBeastControlDevice, beastObjvar) )
				{
					obj_var_list beastData = getObjVarList(selectedBeastControlDevice, beastObjvar);
					if ( beastData != null )
					{
						setBCDDataObjVars(player, barn, nextAvailableStorageSlot+"."+ beastObjvar +".", beastData);
					}
					else
					{
						if ( hasObjVar(barn, nextAvailableStorageSlot) )
						{
							removeObjVar(barn, nextAvailableStorageSlot);
						}
						CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" could not store a beast in the barn. The BCD was not destroyed. Reason: Beast in datapad had no objvars or objvars were corrupted. Barn: "+barn);
						return false;
					}
				}
			}
		}
		else
		{
			if ( hasObjVar(barn, nextAvailableStorageSlot) )
			{
				removeObjVar(barn, nextAvailableStorageSlot);
			}
			CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" could not store a beast in the barn. The BCD was not destroyed. Reason: BCD template was null or corrupted in player datapad. Barn: "+barn);
			return false;
		}
	}
	else
	{
		CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" could not store a beast in the barn. The BCD was not destroyed. Reason: Barn slot came back null or the Barn was full. Barn: "+barn);
		return false;
	}

	CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" is storing a beast BCD: "+selectedBeastControlDevice+" on barn: "+barn);

	beast_lib.storeBeast(selectedBeastControlDevice);
	destroyObject(selectedBeastControlDevice);
	return true;
}

obj_id transferBeastControlDeviceFromBarn(string selectedStorageSlot, obj_id player, obj_id barn)
{
	obj_id bcd = obj_id.NULL_ID;

	if( callable.hasMaxStoredCombatPets(player) )
	{
		sendSystemMessage(player, new string_id("tcg", "barn_beast_reclaim_player_datapad_full"));
		return obj_id.NULL_ID;
	}

	obj_id datapad = utils.getPlayerDatapad(player);
	if( isIdValid(datapad) )
	{
		string bcdTemplate = getStringObjVar(barn, "barnStorage."+selectedStorageSlot+".bcdTemplate");
		if ( bcdTemplate != null && bcdTemplate.length() > 0 )
		{
			bcd = createObject(bcdTemplate, datapad, "");
			if ( isIdValid(bcd) )
			{
				for ( int i = 0; i < BEAST_OBJVARS.length; i++ )
				{
					string beastObjvar = BEAST_OBJVARS[i];
					if ( hasObjVar(barn, "barnStorage."+selectedStorageSlot+"."+beastObjvar) )
					{
						obj_var_list beastData = getObjVarList(barn, "barnStorage."+selectedStorageSlot+"."+beastObjvar);
						if ( beastData != null )
						{
							setBCDDataObjVars(player, bcd, beastObjvar+".", beastData);
						}
						else
						{
							CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" did not claim beast BCD from barn. Resason: barnStorage has null or corrupted beast data for: "+selectedStorageSlot+". Beast Obj Var: "+beastObjvar+".");
							destroyObject(bcd);
							return obj_id.NULL_ID;
						}
					}
				}

				attachScript(bcd, "ai.beast_control_device");
				setName(bcd, beast_lib.getBCDBeastName(bcd));

				if( hasObjVar(barn, "barnStorage."+selectedStorageSlot+"."+BEAST_ROAMING) )
				{
					obj_id displayedBeast = getObjIdObjVar(barn, "barnStorage."+selectedStorageSlot+"."+BEAST_ROAMING);
					if ( isIdValid(displayedBeast) && exists(displayedBeast) )
					{
						destroyObject(displayedBeast);
					}
				}

				removeObjVar(barn, "barnStorage."+selectedStorageSlot);
			}
			else
			{
				CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" did not claim beast BCD from barn. Resason: BCD creation failed.");
				//sendSystemMessage(player, "BCD creation failed!", "");
			}
		}
		else
		{
			CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" did not claim beast BCD from barn. Resason: BCD template was invalid.");
			//sendSystemMessage(player, "BCD template was invalid!", "");
		}
	}
	else
	{
		CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" did not claim beast BCD from barn. Resason: Player's datapad was invalid.");
		//sendSystemMessage(player, "Player's datapad was invalid!", "");
	}
	CustomerServiceLog( "playerStructure", "Player: "+player+" "+getPlayerName(player)+" is about to claim beast BCD: "+bcd+" from barn: "+barn+".");
	return bcd;
}

void setBCDDataObjVars(obj_id player, obj_id target, string objvarNamePrefix, obj_var_list data)
{
	int numItem = data.getNumItems();
	for ( int i = 0; i < numItem; i++ )
	{
		obj_var dataObjvar = data.getObjVar(i);
		string dataObjvarName = dataObjvar.getName();

		if ( data.isIntObjVar(dataObjvarName) )
		{
			int intData = data.getIntObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, intData);
		}
		else if ( data.isIntArrayObjVar(dataObjvarName) )
		{
			int[] intArrayData = data.getIntArrayObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, intArrayData);
		}
		else if ( data.isFloatObjVar(dataObjvarName) )
		{
			float floatData = data.getFloatObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, floatData);
		}
		else if ( data.isFloatArrayObjVar(dataObjvarName) )
		{
			float[] floatArrayData = data.getFloatArrayObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, floatArrayData);
		}
		else if ( data.isStringObjVar(dataObjvarName) )
		{
			string stringData = data.getStringObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, stringData);
		}
		else if ( data.isStringArrayObjVar(dataObjvarName) )
		{
			string[] stringArrayData = data.getStringArrayObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, stringArrayData);
		}
		else if ( data.isObjIdObjVar(dataObjvarName) )
		{
			obj_id objIdData = data.getObjIdObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, objIdData);
		}
		else if ( data.isObjIdArrayObjVar(dataObjvarName) )
		{
			obj_id[] objIdArrayData = data.getObjIdArrayObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, objIdArrayData);
		}
		else if ( data.isBooleanObjVar(dataObjvarName) )
		{
			boolean booleanData = data.getBooleanObjVar(dataObjvarName);
			setObjVar(target, objvarNamePrefix + dataObjvarName, booleanData);
		}
		else
		{
			if ( isGod(player) )
			{
				sendSystemMessage(player, "God Mode Message::Unknown data type for "+dataObjvarName+".", "");
			}
		}
	}
	return;
}

string getNextAvailableBarnStorageSlot(obj_id barn, obj_id player)
{
	string storageSlot = "";

	int maxStoredPets = MAX_NUM_BARN_PETS;
	if ( isBarnLiteDevice(barn)  )
	{
		maxStoredPets = getMaxBarnLiteBeasts(barn);
	}

	if ( hasObjVar(barn, "barnStorage") )
	{
		obj_var_list barnStorageData = getObjVarList(barn, "barnStorage");
		if ( barnStorageData != null )
		{
			int numItem = barnStorageData.getNumItems();
			if ( numItem < maxStoredPets )
			{
				for ( int i = 0; i < maxStoredPets; i++ )
				{
					string testName = "slot_0"+i;
					if ( i > 9 )
					{
						testName = "slot_"+i;
					}
					if ( !barnStorageData.hasObjVar(testName) )
					{
						storageSlot = "barnStorage."+testName;
						break;
					}
				}
			}
			else
			{
				if ( isBarnLiteDevice(barn)  )
				{
					sendSystemMessage(player, new string_id ("tcg","barn_is_full"));
				}
				else
				{
					sendSystemMessage(player, new string_id ("tcg","barn_lite_device_full"));
				}
			}
		}
	}
	else
	{
		storageSlot = "barnStorage.slot_00";
	}

	return storageSlot;
}

string[] getBarnBeastStorageSlots(obj_id barn)
{
	obj_var_list beastData = getObjVarList(barn, "barnStorage");
	if ( beastData != null )
	{
		int numItems = beastData.getNumItems();
		string[] slots = new string[numItems];
		for ( int i = 0; i < numItems; i++ )
		{
			obj_var beastDataObjvar = beastData.getObjVar(i);
			string beastDataObjvarName = beastDataObjvar.getName();
			slots[i] = beastDataObjvarName;
		}

		return slots;
	}

	return null;
}

int getTotalBarnStoredBeastsFromRanchhand(obj_id ranchhand)
{
	int numStoredBeasts = 0;

	if( isIdValid(ranchhand) && exists(ranchhand) )
	{
		obj_id barn = getTopMostContainer(ranchhand);
		if( isIdValid(barn) )
		{
			numStoredBeasts = getTotalBarnStoredBeasts(barn);
		}
	}

	return numStoredBeasts;
}

int getTotalBarnStoredBeasts(obj_id barn)
{
	int numStoredBeasts = 0;

	if( isIdValid(barn) && exists(barn) )
	{
		obj_var_list beastStorageData = getObjVarList(barn, "barnStorage");
		if ( beastStorageData != null )
		{
			numStoredBeasts = beastStorageData.getNumItems();
		}
	}

	return numStoredBeasts;
}

obj_id barnDisplayBeast(obj_id ranchhand, string storageSlot, obj_id barn)
{
	location here = getLocation(ranchhand);
	location spawnCenter = new location(-7.0f, 0.0f, -2.4f, here.area, here.cell);
	location spawnLocation = spawning.getRandomLocationInCircle(spawnCenter, 5.0f);

	return barnDisplayBeast(ranchhand, storageSlot, barn, spawnLocation);
}

obj_id barnDisplayBeast(obj_id ranchhand, string storageSlot, obj_id barn, location where)
{
	string beastType ="";
	if( hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_TYPE) )
	{
		int hashBeastType = getIntObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_TYPE);
		beastType = incubator.convertHashTypeToString(hashBeastType);
	}
	if( beastType == null || beastType.length() < 1 )
	{
		return obj_id.NULL_ID;
	}

	dictionary beastDict = utils.dataTableGetRow(beast_lib.BEASTS_TABLE, beastType);
	if(beastDict == null)
	{
		return obj_id.NULL_ID;
	}

	string mobileTemplateName = beastDict.getString("template");
	if(mobileTemplateName == "" || mobileTemplateName == null)
	{
		return obj_id.NULL_ID;
	}

	obj_id beast = createObject(beast_lib.MOBILE_TEMPLATE_PREFIX + mobileTemplateName, where);
	if(!isIdValid(beast))
	{
		return obj_id.NULL_ID;
	}

	colorBeastUsingBarnData(beast, barn, storageSlot);

	setObjVar(barn, "barnStorage."+storageSlot+"."+BEAST_ROAMING, beast); //Display var

	utils.setScriptVar(beast, "barnSlot", storageSlot);
	utils.setScriptVar(beast, "barnId", barn);

	beast_lib.setBeastBCD(beast, barn);

	utils.setScriptVar(beast, "beast.creationInProgress", true);

	initializeBeastStatsFromBarn(barn, beast, storageSlot, beastType);

	setYaw(beast, rand(0.0f, 360.0f));

	utils.removeScriptVar(beast, "beast.creationInProgress");

	setAttributeAttained(beast, attrib.BEAST);

	attachScript(beast, BARN_BEAST_SCRIPT);
	attachScript(beast, "ai.ai");

	setInvulnerable(beast, true);
	
	setObjVar(beast, "noEject", true);

	return beast;
}

void initializeBeastStatsFromBarn(obj_id barn, obj_id beast, string storageSlot, string beastType)
{
	colorBeastUsingBarnData(beast, barn, storageSlot);

	int level = 1;
	if(hasObjVar(barn, "barnStorage."+storageSlot+".beast.level"))
	{
		level = getIntObjVar(barn, "barnStorage."+storageSlot+".beast.level");
	}
	setLevel(beast, level);

	string beastName = beast_lib.getBeastLocalizedName(beast);
	if ( hasObjVar(barn, "barnStorage."+storageSlot+".beast.beastName") )
	{
		beastName = getStringObjVar(barn, "barnStorage."+storageSlot+".beast.beastName");
	}
	else if ( hasObjVar(barn, "barnStorage."+storageSlot+".tempName") )
	{
		beastName = getStringObjVar(barn, "barnStorage."+storageSlot+".tempName");
	}
	setName(beast, beastName);

	dictionary beastDict = utils.dataTableGetRow(beast_lib.BEASTS_TABLE, beastType);
	if(beastDict == null || beastDict.size() <= 0)
	{
		return;
	}

	dictionary beastStatsDict = utils.dataTableGetRow(beast_lib.BEASTS_STATS, level - 1);
	if(beastStatsDict == null || beastStatsDict.size() <= 0)
	{
		return;
	}

	int [] incubationBonuses = new int[beast_lib.ARRAY_BEAST_INCUBATION_STATS.length];

	if(hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_INCUBATION_BONUSES) )
	{
		incubationBonuses = getIntArrayObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_INCUBATION_BONUSES);
	}
	else
	{
		for(int i = 0; i < beast_lib.ARRAY_BEAST_INCUBATION_STATS.length; ++i)
		{
			incubationBonuses[i] = 0;
		}
	}

	for(int i = 0; i < beast_lib.ARRAY_BEAST_INCUBATION_STATS.length; ++i)
	{
		utils.setScriptVar(beast, beast_lib.ARRAY_BEAST_INCUBATION_STATS[i], (float)incubationBonuses[i]);
	}

	//add species bonuses
	beast_lib.addInnateBeastBonuses(beast, beastType);

	//add skill point bonuses
	beast_lib.setBeastSkillBonuses(beast);

	setScale(beast, beast_lib.getBeastScaleByLevel(beast));

	// Terrain Negotiation
	addSkillModModifier(beast, "slope_move", "slope_move", 50, -1, false, false);

	// Recalculate happiness
	//updateBeastHappiness(bcd, beast);

	//////////////
	// Base expertise modifiers.
	//////////////

	int expertiseRegen = getEnhancedSkillStatisticModifierUncapped(getMaster(beast), "expertise_bm_pet_regen");
	int expertiseHealth = getEnhancedSkillStatisticModifierUncapped(getMaster(beast), "expertise_bm_pet_health");
	int expertiseAttackSpeed = getEnhancedSkillStatisticModifierUncapped(getMaster(beast), "expertise_bm_pet_attack_speed");
	int expertiseArmor = getEnhancedSkillStatisticModifierUncapped(getMaster(beast), "expertise_bm_pet_armor");
	int expertiseDamage = getEnhancedSkillStatisticModifierUncapped(getMaster(beast), "expertise_bm_pet_damage");

	// Incubation bonuses
	float incubationArmorBonus = utils.getFloatScriptVar(beast, beast_lib.OBJVAR_INCREASE_ARMOR);
	float incubationDamageBonus = utils.getFloatScriptVar(beast, beast_lib.OBJVAR_INCREASE_DPS);
	float incubationHealthBonus = utils.getFloatScriptVar(beast, beast_lib.OBJVAR_INCREASE_HEALTH);

	// Weapons and damage ranges
	int intMinDamage = (int)beastStatsDict.getInt("MinDmg");
	int intMaxDamage = (int)beastStatsDict.getInt("MaxDmg");
	intMinDamage = beast_lib.getExpertiseStat(intMinDamage, expertiseDamage, .5f);
	intMaxDamage = beast_lib.getExpertiseStat(intMaxDamage, expertiseDamage, .5f);

	float floatMinDamage = (float)intMinDamage * (1.0f + incubationDamageBonus / 100.0f);
	float floatMaxDamage = (float)intMaxDamage * (1.0f + incubationDamageBonus / 100.0f);
	intMinDamage = (int)floatMinDamage;
	intMaxDamage = (int)floatMaxDamage;

	//The above only does white damage. This nerfs special damage as well.
	int specialDamagePercent = beast_lib.getExpertiseStat(100, expertiseDamage, .5f) - 100;

	if(!hasSkillModModifier (beast, "expertise_damage_line_beast_only"))
	{
		addSkillModModifier(beast, "expertise_damage_line_beast_only", "expertise_damage_line_beast_only", specialDamagePercent, -1, false, false);
	}

	float primarySpeed = beast_lib.getExpertiseSpeed(beast_lib.BEAST_WEAPON_SPEED, expertiseAttackSpeed);

	// Weapon initialization
	obj_id beastWeapon = getCurrentWeapon(beast);

	if(isIdValid(beastWeapon))
	{
		setWeaponAttackSpeed(beastWeapon, primarySpeed);
		setWeaponMaxDamage(beastWeapon, intMaxDamage);
		setWeaponMinDamage(beastWeapon, intMinDamage);
		weapons.setWeaponData(beastWeapon);

		utils.setScriptVar(beastWeapon, "isCreatureWeapon", 1);
	}

	obj_id defaultWeapon = getDefaultWeapon(beast);

	if(isIdValid(defaultWeapon))
	{
		setWeaponAttackSpeed(defaultWeapon, primarySpeed);
		setWeaponMaxDamage(defaultWeapon, intMaxDamage);
		setWeaponMinDamage(defaultWeapon, intMinDamage);
		weapons.setWeaponData(defaultWeapon);

		utils.setScriptVar(defaultWeapon, "isCreatureWeapon", 1);
	}

	// Stats
	int beastHealth = (int)(beast_lib.getExpertiseStat(beastStatsDict.getInt("HP"), expertiseHealth, .5f) * (1.0f + (incubationHealthBonus * 0.2f) / 100.0f));

	int constitutionBonus =  getEnhancedSkillStatisticModifierUncapped(beast, "constitution_modified");
	int staminaBonus = getEnhancedSkillStatisticModifierUncapped(beast, "stamina_modified");

	beastHealth += (constitutionBonus * 8) + (staminaBonus * 2);

	setMaxAttrib(beast, HEALTH, beastHealth);

	beastHealth = 0;
	if ( hasObjVar(barn, "barnStorage."+storageSlot+".beast.health") )
	{
		beastHealth = getIntObjVar(barn, "barnStorage."+storageSlot+".beast.health");
	}

	if(beastHealth <= 0)
	{
		setAttrib(beast, HEALTH, getMaxAttrib(beast, HEALTH));
	}
	else
	{
		if(utils.hasScriptVar(beast, "beast.creationInProgress"))
		{
			setAttrib(beast, HEALTH, beastHealth);
			setAttrib(beast, ACTION, 100);
		}

		boolean beastIsDead = false;
		if( hasObjVar(barn, "barnStorage."+storageSlot+".beast.isDead") )
		{
			beastIsDead = getBooleanObjVar(barn, "barnStorage."+storageSlot+".beast.isDead");
		}

		if( beastIsDead )
		{
			kill(beast);
		}
	}

	setMaxAttrib(beast, ACTION, 100);

	if(!combat.isInCombat(beast))
	{
		int healthRegen = beast_lib.getExpertiseStat(beastStatsDict.getInt("HealthRegen"), expertiseRegen, .5f);
		int actionRegen = beast_lib.getExpertiseStat(beastStatsDict.getInt("ActionRegen"), expertiseRegen, .5f);

		setRegenRate(beast, HEALTH, healthRegen);
		setRegenRate(beast, ACTION, actionRegen);
	}

	// Movement
	float runSpeed = 12;
	setBaseRunSpeed(beast, runSpeed);
	if( getBaseWalkSpeed(beast) > runSpeed )
	{
		setBaseWalkSpeed(beast, runSpeed);
	}

	/////////////
	// Armor
	/////////////

	// Set base armor info
	// Clear out any existing armor data

	armor.removeAllArmorData(beast);

	int intArmor = (int)(beast_lib.getExpertiseStat(beastStatsDict.getInt("Armor"), expertiseArmor, .5f) * (1.0f + incubationArmorBonus / 100.0f));

	intArmor += (int)getSkillStatisticModifier(beast, "expertise_innate_protection_all");

	utils.setScriptVar(beast, "beast.display.armor", intArmor);

	if( intArmor >= 0 )
	{
		// Set base armor info
		string armorCategoryObjVar = armor.OBJVAR_ARMOR_BASE + "." + armor.OBJVAR_ARMOR_CATEGORY;
		setObjVar(beast, armorCategoryObjVar, AC_battle);

		string armorLevelObjVar = armor.OBJVAR_ARMOR_BASE + "." + armor.OBJVAR_ARMOR_LEVEL;
		setObjVar(beast, armorLevelObjVar, AL_standard);

		string genProtectionObjVar = armor.OBJVAR_ARMOR_BASE + "." + armor.OBJVAR_GENERAL_PROTECTION;
		setObjVar(beast, genProtectionObjVar, (float)intArmor);
		utils.setScriptVar(beast, armor.SCRIPTVAR_CACHED_GENERAL_PROTECTION, intArmor);
	}

	int exp = 0;
	if(hasObjVar(barn, "barnStorage."+storageSlot+".beast.experience"))
	{
		exp = getIntObjVar(barn, "barnStorage."+storageSlot+".beast.experience");
	}
	beast_lib.setBeastExperience(beast, exp);

	boolean canLevel = false;
	if(hasObjVar(barn, "barnStorage."+storageSlot+".beast.canLevel"))
	{
		canLevel = getBooleanObjVar(barn, "barnStorage."+storageSlot+".beast.canLevel");
	}
	beast_lib.setBeastCanLevel(beast, canLevel);

	// Initialize Incubation Modifiers

	// Apply "Divided Attention" debuff
	// Ok. Setting a custom value on a buff works but there's a display problem where the first value displayed is the only
	// one shown and never changes even if the value changes. So we'll use five different buffs rather then risk waiting on a programming fix.
	int attentionPenaltyReduction = getEnhancedSkillStatisticModifierUncapped(getMaster(beast), "expertise_bm_self_debuff_reduction");
	int attentionPenalty = beast_lib.BASE_ATTENTION_PENALTY + attentionPenaltyReduction;
	int hackeyWorkAroundValue = (attentionPenalty / 5) * -1;

	if(hackeyWorkAroundValue > 5)
	{
		hackeyWorkAroundValue = 5;
	}

	if(attentionPenalty < 0 || hackeyWorkAroundValue > 0)
	{
		buff.applyBuff(getMaster(beast), beast_lib.ATTENTION_PENALTY_DEBUFF + hackeyWorkAroundValue);
	}
	else
	{
		beast_lib.removeAttentionPenaltyDebuff(getMaster(beast));
	}

	return;
}

boolean isBarnLiteDevice(obj_id object)
{
	return hasObjVar(object, "barnLite.isBarnLite");
}

int getMaxBarnLiteBeasts(obj_id barn_lite_device)
{
	int maxNum = DEFAULT_NUM_BARN_LITE_PETS;
	if ( hasObjVar(barn_lite_device, "crafting_components.capacity") )
	{
		maxNum = (int)getFloatObjVar(barn_lite_device, "crafting_components.capacity");
	}
	return maxNum;
}

/***** End Barn functions *********************************************/
/**********************************************************************/

//Unpacks a TCG object that has a colon delimeted list on it as a string objvar.
//This is a lot like the player uniform package they received when they reached level 5.
boolean grantPackageContents(obj_id objectPacked, obj_id player)
{
	if(!isValidId(objectPacked) || !exists(objectPacked))
		return false;
	if(!isValidId(player) || !exists(player))
		return false;
	if(!hasObjVar(objectPacked, "tcg.object"))
		return false;

	string objList = getStringObjVar(objectPacked, "tcg.object");
	if(objList == null || objList.equals(""))
		return false;


	string[] staticObjects = split(objList, ':');
	if(staticObjects == null)
		return false;


	for(int i = 0; i < staticObjects.length; i++)
	{
		obj_id unpackedObject = static_item.createNewItemFunction(staticObjects[i], player);
		CustomerServiceLog("tcg", "Packed item: "+ objectPacked + " " + getName(objectPacked) + " unpacked: " +unpackedObject+" "+getName(unpackedObject)+" for player: "+ player + " " + getName(player)+".");
	}

	return true;
}

boolean colorBeastUsingBarnData(obj_id beast, obj_id barn, string storageSlot)
{
	if(!isValidId(beast) || !exists(beast))
		return false;
	if(!isValidId(barn) || !exists(barn))
		return false;
	if(storageSlot == null || storageSlot.length() <= 0)
		return false;

	boolean useBeastLibraryHue = false;
	obj_id bcd = beast_lib.getBeastBCD(beast);
	if(isValidId(bcd) && exists(bcd))
		useBeastLibraryHue = true;

	//get the hues for the beast
	int primaryHue = -1;
	if ( hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_HUE) )
	{
		primaryHue = getIntObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_HUE);
	}
	int secondaryHue = -1;
	if ( hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_HUE2) )
	{
		secondaryHue = getIntObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_HUE2);
	}
	int thirdHue = -1;
	if ( hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_HUE3) )
	{
		thirdHue = getIntObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_HUE3);
	}

	string primaryPalette = "";
	if ( hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_PALETTE) )
	{
		primaryPalette = getStringObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_PALETTE);

	}
	string secondaryPalette = "";
	if ( hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_PALETTE2) )
	{
		secondaryPalette = getStringObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_PALETTE2);
	}
	string thirdPalette = "";
	if ( hasObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_PALETTE3) )
	{
		thirdPalette = getStringObjVar(barn, "barnStorage."+storageSlot+"."+beast_lib.OBJVAR_BEAST_PALETTE3);
	}


	//set the hues on the beast
	if(primaryHue >= 0 && (primaryPalette == null || primaryPalette.length() <= 0))
	{
		setRoamingBeastHue(beast, "/private/index_color_1", primaryHue);
	}
	else
	{
		if(!useBeastLibraryHue)
		{
			if(primaryPalette != null || primaryPalette.length() > 0)
				setRoamingBeastHue(beast, primaryPalette, primaryHue);
			if(secondaryPalette != null || secondaryPalette.length() > 0)
				setRoamingBeastHue(beast, secondaryPalette, secondaryHue);
			if(thirdPalette != null || thirdPalette.length() > 0)
				setRoamingBeastHue(beast, thirdPalette, thirdHue);
		}
		else
		{
			if(primaryPalette != null || primaryPalette.length() > 0)
				beast_lib.setBeastHuePrimary(beast, primaryPalette, primaryHue);
			if(secondaryPalette != null || secondaryPalette.length() > 0)
				beast_lib.setBeastHueSecondary(beast, secondaryPalette, secondaryHue);
			if(thirdPalette != null || thirdPalette.length() > 0)
				beast_lib.setBeastHueThird(beast, thirdPalette, thirdHue);
		}
	}
	return true;
}

boolean setRoamingBeastHue(obj_id beast, string palette, int hueIndex)
{
	if(!isValidId(beast) || !exists(beast))
		return false;
	if(palette == null || palette.length() <= 0)
		return false;
	if(hueIndex < 0)
		return false;

	hue.setColor(beast, palette, hueIndex); // palette was "/private/index_color_1"
	return true;
}

boolean showRoamingBeasts(obj_id barn, obj_id ranchhand)
{

	if(!isValidId(barn) || !exists(barn))
		return false;
	if(!isValidId(ranchhand) || !exists(ranchhand))
		return false;

	string[] initialStorageList = getBarnBeastStorageSlots(barn);
	if( initialStorageList == null || initialStorageList.length < 1)
		return false; //FAILING HERE!!!

	blog("tcg.scriptlib = showRoamingBeasts --- initialStorageList.length: "+initialStorageList.length);

	for(int i = 0; i < initialStorageList.length; i++)
	{
		blog("tcg.scriptlib = showRoamingBeasts --- loop: "+i);
		string bcdSlot = initialStorageList[i];
		if(!hasObjVar(barn, "barnStorage."+bcdSlot+"."+BEAST_ROAMING))
			continue;

		obj_id beastId = getObjIdObjVar(barn, "barnStorage."+bcdSlot+"."+BEAST_ROAMING);
		if(isValidId(beastId) && exists(beastId))
		{
			blog("tcg.scriptlib = showRoamingBeasts --- beastId FOUND, already exists: "+beastId);
			continue;
		}

		blog("tcg.scriptlib = showRoamingBeasts --- NEED ROAMING BEAST FOUND AT bcdSlot: "+bcdSlot);
		if ( isBarnLiteDevice(barn) )
		{
			location here = getLocation(barn);
			location spawnLoc = spawning.getRandomLocationAtDistance(getLocation(barn), 2.0f);

			tcg.barnDisplayBeast(ranchhand, bcdSlot, barn, spawnLoc);
		}
		else
		{
			barnDisplayBeast(ranchhand, bcdSlot, barn);
		}
	}

	return true;
}

boolean setupDeathStarFix(obj_id table)
{
	if(!isValidId(table) || !exists(table))
		return false;

	int idx = rand(0, DEFAULT_HIGH_SCORE_MODIFIER.length-1);
	float modifier = DEFAULT_HIGH_SCORE_MODIFIER[idx];
	fixDeathStarScores(table, "death_star", modifier);
	return true;
}

boolean fixDeathStarScores(obj_id table, string layout, float modifier)
{
	if(!isValidId(table) || !exists(table))
		return false;
	if(layout == null || layout.equals(""))
		return false;
	if(modifier < 0)
		return false;

	for(int i = 1; i <= MAX_NUMBER_OF_HIGH_SCORES; i++)
	{
		int randomPosition = rand(0,DEFAULT_HIGH_SCORE_LIST.length-1);
		string name = DEFAULT_HIGH_SCORE_LIST[randomPosition];
		float score = ((EST_MAX_SCORE * modifier) / i);
		int scoreInt = (int)score;
		string timeDate = getCalendarTimeStringLocal(getCalendarTime());
		string stringData = scoreInt + "." + name + "." + layout + "." + timeDate;
		setObjVar(table, TABLE_HIGHSCORE_SLOTS+"."+layout+".slot_"+i, stringData);
	}
	return true;	
}

boolean blog(string msg)
{
	if(LOGGING_ON && msg != null && !msg.equals(""))
		LOG(LOGGING_CATEGORY, msg);
	return true;
}