U2.VoiceList

//=============================================================================
// VoiceList.uc
// $Author: Mbaldwin $
// $Date: 10/18/02 6:00p $
// $Revision: 3 $
//=============================================================================

class VoiceList extends Actor
	placeable;

//-----------------------------------------------------------------------------

#exec Texture Import File=Textures\VoiceList.pcx GROUP=Icons Name=VoiceList Mips=Off Masked=1

//-----------------------------------------------------------------------------

struct VerifyInfoT
{
	var() SoundSlotInterf.ESoundTableSlot Group;	// sound category
	var() int MinSounds;							// lower sound limit
	var() int MaxSounds;							// upper sound limit
};

//-----------------------------------------------------------------------------

var() array<string>		 Packages;		// list of voice package names
var int					 Next;			// index of next package to hand out.

// debug
var() array<VerifyInfoT> VerifyInfo;	// info the verify validity of assets
var() bool bVerify;						// verify there are enough sounds in each group

//-----------------------------------------------------------------------------

static function string GetVoicePackage( U2Pawn U2P )
{
	local VoiceList VL;
	local Actor A;

	// no voice list params, no package
	if( U2P.VoiceListTag == '' && U2P.VoiceListClass == None )
		return "";

	if( U2P.VoiceListTag != '' )			// search by tag
	{
		foreach U2P.AllActors( class'VoiceList', VL, U2P.VoiceListTag )
			break;

		if( VL == None )
			Warn( "VoiceList -- unable to find list with tag: '" $ U2P.VoiceListTag );
	}

	if( VL == None && U2P.VoiceListClass != None )	// search by voice list class
	{
		foreach U2P.AllActors( U2P.VoiceListClass, A )	// won't compile if VL is used directly (as above)
		{
			VL = VoiceList(A);
			if( VL != None )
				break;
		}
	}

	// spawn one if there are no pre-existing voice lists
	if( VL == None )
		VL = U2P.Spawn( U2P.VoiceListClass );

	return VL.GetNextPackage();
}

//-----------------------------------------------------------------------------

function string GetNextPackage()
{
	local string Result;

	if( Next < Packages.Length )
	{
		Result = Packages[Next];
		Next = (Next + 1) % Packages.Length;
	}
	else
		Warn( "VoiceList -- Error trying to access voice package #" @ Next @ "of" @ Self );

	return Result;
}


//-----------------------------------------------------------------------------

event PreBeginPlay()
{
	Super.PreBeginPlay();
	if( bVerify )
	{
		DM("Verifying Voice Packages for" @ Class.Name);
		if( VerifyPackages() )
			DM("All voice packages in" @ Class.Name @ "have PASSED");
		else
			DM("One or more packages in" @ Class.Name @ "have FAILED");
	}
}

//-----------------------------------------------------------------------------

function bool VerifyPackages()
{
	local int i;
	local bool success;

	success = true;

	for( i=0; i < Packages.Length; i++ )
	{
		DM("Verifying Voice package '" $ Packages[i] $ "'");
		if( !VerifySinglePackage( Packages[i] ) )
		{
			success = false;
			DM("     Package FAILED");
		}
		else DM("     Package PASSED");
	}

	return success;
}

//-----------------------------------------------------------------------------

function bool VerifySinglePackage( string PackageName )
{
	local int i, Count;
	local SoundTable ST;
	local bool Success;

	ST = class'SoundTable'.static.GetInstance( Self, PackageName );
	if( ST != None )
	{
		Success = true;
		for( i=0; i < VerifyInfo.Length; i++ )
		{
			Count = ST.GetNumSounds( VerifyInfo[i].Group );
			if( Count < VerifyInfo[i].MinSounds )
			{
				Success = false;
				DM("Voice package '" $ PackageName $ "' has too few sounds in group '" $ EnumStr(enum'ESoundTableSlot', VerifyInfo[i].Group) $ "' (" $ Count $ "/" $ VerifyInfo[i].MinSounds $ ")");
			}
		}
	}
	return Success;
}

//-----------------------------------------------------------------------------

defaultproperties
{
	bHidden=true
	Texture=Texture'U2.Icons.VoiceList'
     UseReticleOnEvents(0)="UseReticleText"
     UseReticleOnEvents(1)="UseReticleCorners"
     UseReticleOnEvents(2)="UseReticleTopBars"
     ProximityReticleOnEvents(0)="ProximityReticleCorners"
     ProximityReticleOnEvents(1)="ProximityReticleTopBars"
}