U2.AssetsHelperGeneric

//=============================================================================
// AssetHelperGeneric.uc
// $Author: Mbaldwin $
// $Date: 12/15/02 2:40a $
// $Revision: 57 $
//=============================================================================

class AssetsHelperGeneric extends LegendObjectComponent
	abstract;

//=============================================================================
// AssetHelperGeneric:
//
// Wrapper class for handling various asset-related issues (texture/damage 
// sounds, animations, effects) as an Actor moves, takes damage etc.
//=============================================================================

const PlayerHearingRadius	= 3000.0;
const TeammateHearingRadius = 1000.0;

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

var(U2Sounds) class<TextureHelperGeneric>	LandTextureHelperClass;
var(U2Sounds) class<TextureHelperGeneric>	MoveTextureHelperClass;
var(U2Sounds) class<TextureHelperGeneric>	ProneTextureHelperClass;
var(U2Sounds) class<TextureHelperGeneric>	BodyLandTextureHelperClass;

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

private static function HandleLandedSound( U2Pawn U2P, float ImpactSpeed )
{
	//U2P.DMTNS( "HandleLandedSound: " $ ImpactSpeed );

	if( U2P? && U2P.SoundTable? )
	{
		//!!mb (mdf) SLOT_Talk sounds getting stomped?
		U2P.StopSoundSlot( SLOT_Talk );
		
		// NOTE: if Pawn takes damage, the damage sound will (and should) spam the landed sound	
		if( ImpactSpeed < U2P.GetLandCompressVelocity() )
		{
			//U2P.DMTNS( "HandleLandedSound - land hard sound" );
			U2P.SoundTable.PlaySlotSound( U2P, STS_LandHard, true, SLOT_Pain );
		}
		else
		{
			//U2P.DMTNS( "HandleLandedSound - land soft sound" );
			U2P.SoundTable.PlaySlotSound( U2P, STS_LandSoft, true, SLOT_Pain );
		}
	}
}

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

static function HandleLandedOnTexture( U2Pawn U2P, float ImpactSpeed )
{
	//U2P.DMTNS( "HandleLandedOnTexture: " $ ImpactSpeed );

	if( !U2P? ) return;
	
	default.LandTextureHelperClass.static.HandleLandingOnTexture( U2P, ImpactSpeed );

	if( U2P.Health > 0 && ImpactSpeed < U2P.GetLandMakeNoiseVelocity() )
	{
		//U2P.DMTNS( "HandleLandedOnTexture calling MakeNoise: " );

		U2P.MakeNoise( 1.0 );
		
		HandleLandedSound( U2P, ImpactSpeed );
	}
}

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

static function HandleBodyLandedOnTexture( U2Pawn U2P, float ImpactSpeed )
{
	//U2P.DMTNS( "HandleLandedOnTexture: " $ ImpactSpeed );
	if( U2P? ) default.BodyLandTextureHelperClass.static.HandleLandingOnTexture( U2P, ImpactSpeed );
}

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

static function HandleMovingOnTexture( U2Pawn U2P )
{
	if( U2P? ) default.MoveTextureHelperClass.static.HandleMovingOnTexture( U2P );
}

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

static function HandleProneMovingOnTexture( U2Pawn U2P )
{
	if( U2P? ) default.ProneTextureHelperClass.static.HandleMovingOnTexture( U2P );
}

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

static function HandleFallingSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_Falling );
}

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

static function StopFallingSound( U2Pawn U2P )
{
	//U2P.DMTNS( "StopFallingSound calling StopSlotSound" );
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.StopSlotSound( U2P, STS_Falling );
}

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

static function HandleJumpSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_Jump );
}

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

static function HandleMantleBeginSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_Mantle );
}

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

static function HandleLeapSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_Leap, true, SLOT_Misc );
}

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

static function HandleLeapImpactSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_LeapImpact, true, SLOT_None );
}

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

static function HandleLeapLandSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_LeapLand, true, SLOT_None );
}

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

static function HandleMiscSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_Misc );
}

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

static function HandleMeleeMotionSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_MeleeMotion, true, SLOT_Interact );
}

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

static function HandleMeleeImpactPointSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_MeleeImpactPoint, true, SLOT_Misc );
}

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

static function HandleMeleeDamageSound( U2Pawn U2P )
{
	if( U2P? ) 
	{
		if( U2Weapon(U2P.Weapon) != None )
			U2P.PlaySound( U2Weapon(U2P.Weapon).GetGunButtSound(), SLOT_Weapon );
		else if( U2P.SoundTable? )
			U2P.SoundTable.PlaySlotSound( U2P, STS_MeleeDamage, true, SLOT_Interact );
	}
}

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

static function HandleTakeHitSound( U2Pawn U2P, int Damage, class<DamageType> DamageType )
{
	//U2P.DMTNS( "HandleTakeHitSound" );
	if( U2P? && U2P.SoundTable? )
	{
		//!!MB (mdf) SLOT_Talk / bNoOverride is borking?
		//U2P.DMTNS( "HandleTakeHitSound stopping SLOT_Talk sound"  );
		U2P.StopSoundSlot( SLOT_Talk );
		if( Damage > 20 )
			U2P.SoundTable.PlaySlotSound( U2P, STS_HitHard, true, SLOT_Pain ); //!!MB (mdf) SLOT_Talk / bNoOverride is borking?
		else
			U2P.SoundTable.PlaySlotSound( U2P, STS_HitSoft, true, SLOT_Pain ); //!!MB (mdf) SLOT_Talk / bNoOverride is borking?
	}
}

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

static function sound HandlePanicSound( U2Pawn U2P, class<DamageType> DamageType )
{
	if( ClassIsChildOf( DamageType, class'DamageTypeBiologicalGas' ) )
		return HandleToxicSound( U2P );
	if( ClassIsChildOf( DamageType, class'DamageTypeLeechGun' ) )
		return HandleSpiderSound( U2P );
	if( ClassIsChildOf( DamageType, class'DamageTypeThermal' ) )
		return HandleOnFireSound( U2P );
}

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

private static function sound HandleToxicSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) 
		return U2P.SoundTable.PlaySlotSound( U2P, STS_Toxic, true, SLOT_Pain );
	else 
		return None;
}

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

private static function sound HandleOnFireSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) 
		return U2P.SoundTable.PlaySlotSound( U2P, STS_OnFire, true, SLOT_Pain );
	else 
		return None;
}

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

private static function sound HandleSpiderSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) 
		return U2P.SoundTable.PlaySlotSound( U2P, STS_Spider, true, SLOT_Pain );
	else 
		return None;
}

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

static function sound HandlePanicSoundEnding( U2Pawn U2P, class<DamageType> DamageType )
{
	if( ClassIsChildOf( DamageType, class'DamageTypeBiologicalGas' ) )
		return HandleToxicEndSound( U2P );
	if( ClassIsChildOf( DamageType, class'DamageTypeLeechGun' ) )
		return HandleSpiderEndSound( U2P );
	if( ClassIsChildOf( DamageType, class'DamageTypeThermal' ) )
		return HandleOnFireEndSound( U2P );
}

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

private static function sound HandleToxicEndSound( U2Pawn U2P )
{
	//mib-tbd: don't have a slot in the new audio format yet
	//if( U2P? && U2P.SoundTable? ) return U2P.SoundTable.PlaySlotSound( U2P, STS_ToxicEnd, true, SLOT_Pain );
	return None;
}

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

private static function sound HandleOnFireEndSound( U2Pawn U2P )
{
	//mib-tbd: don't have a slot in the new audio format yet
	//if( U2P? && U2P.SoundTable? ) return U2P.SoundTable.PlaySlotSound( U2P, STS_OnFireEnd, true, SLOT_Pain );
	
	return None;
}

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

private static function sound HandleSpiderEndSound( U2Pawn U2P )
{
	//mib-tbd: don't have a slot in the new audio format yet
	//if( U2P? && U2P.SoundTable? ) return U2P.SoundTable.PlaySlotSound( U2P, STS_SpiderEnd, true, SLOT_Pain );
	return None;
}

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

static function HandleDyingSound( U2Pawn U2P )
{
	//U2P.DM( "### " $ U2P $ " - Health at death = " $ U2P.Health );

	if( !U2P? || !U2P.SoundTable?) return;

	// Native water creatures shouldn't drown
	if ( U2P.PhysicsVolume.bWaterVolume && U2P.default.MovementPhysics != PHYS_Swimming )
	{
		U2P.SoundTable.PlaySlotSound( U2P, STS_Drown, true, SLOT_Pain );
	}
	else
	{
		if( U2P.Health < -50 )
		{
			//U2P.DM( " *** " $ U2P $ " - Choosing DieHard" );
			U2P.SoundTable.PlaySlotSound( U2P, STS_DieHard, true, SLOT_Pain );	
		}
		else
		{
			//U2P.DM( " *** " $ U2P $ " - Choosing DieSoft" );
			U2P.SoundTable.PlaySlotSound( U2P, STS_DieSoft, true, SLOT_Pain );
		}
	}
}

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

static function HandleGenericASound( U2Pawn U2P, Actor.ESoundSlot SoundSlot  )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_GenericA, true, SoundSlot );
}

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

static function HandleGenericBSound( U2Pawn U2P, Actor.ESoundSlot SoundSlot  )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_GenericB, true, SoundSlot );
}

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

static function HandleGenericCSound( U2Pawn U2P, Actor.ESoundSlot SoundSlot )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_GenericC, true, SoundSlot );
}

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

static function HandleGenericDSound( U2Pawn U2P, Actor.ESoundSlot SoundSlot  )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_GenericD, true, SoundSlot );
}

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

static function HandleGenericESound( U2Pawn U2P, Actor.ESoundSlot SoundSlot  )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STS_GenericE, true, SoundSlot );
}

//=============================================================================
// Flavor Text
//=============================================================================

static function bool UseFlavorText( Actor ContextActor )
{
	return( U2GameInfo(ContextActor.Level.Game) != None &&
			U2GameInfo(ContextActor.Level.Game).bUseCombatSounds );
}

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

static function bool PlayerCanHear( Pawn P )
{
	local PlayerController PC;
	PC = class'UIConsole'.static.GetPlayerOwner();
	return( PC != None &&
			PC.Pawn != None &&
			PC.Pawn.Health > 0 &&
			VSize( PC.Pawn.Location - P.Location ) < PlayerHearingRadius );
}

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

static function bool IsValidListener( Pawn ListeningPawn, Pawn SpeakingPawn  )
{
	return( ListeningPawn != None &&
			ListeningPawn.Health > 0 &&
			ListeningPawn.Controller != None &&
			!ListeningPawn.Controller.bStasis &&
			StationaryPawn(ListeningPawn) == None &&		// filter out xmp items
			ListeningPawn != SpeakingPawn &&
			ListeningPawn.SameTeam( SpeakingPawn ) &&
			SpeakingPawn.TeamNumber == ListeningPawn.default.TeamNumber && // hack so mercs don't react to snipe deaths
			VSize( ListeningPawn.Location - SpeakingPawn.Location ) < TeammateHearingRadius );
}

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

static function U2Pawn FindTeammate( Pawn SpeakingPawn )
{
	local U2Pawn Result;
	local Controller C;

	for ( C=SpeakingPawn.Level.ControllerList; C!=None; C=C.nextController )
		if( IsValidListener(C.Pawn, SpeakingPawn) )
		{
			Result = U2Pawn(C.Pawn);
			break;
		}

	return Result;
}

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

static function bool FlavorTextIsValid( U2Pawn Speaker, optional bool bNeedsTeammate )
{
	return( Speaker != None &&
			!Speaker.bHidden &&
			Speaker.SoundTable != None &&
			Speaker.bUsesFlavorText && 
			PlayerCanHear( Speaker ) &&
			( !bNeedsTeammate || Speaker.bNoFlavorTextTeamCheck || FindTeammate( Speaker ) != None ) );
}

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

static function HandleKilledEnemy( U2Pawn U2P )
{
	if( FlavorTextIsValid( U2P, true ) )
		U2P.SoundTable.PlaySlotSound( U2P, STS_KillsTaunts, true, SLOT_Dialog );
}

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

static function HandleKilledEnemySafe( U2Pawn U2P )
{
	if( FlavorTextIsValid( U2P, true ) )
		U2P.SoundTable.PlaySlotSound( U2P, STS_EndSkirmish, true, SLOT_Dialog );
}

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

static function HandleFriendDead( U2Pawn U2P )
{
	if( FlavorTextIsValid( U2P, false ) )
		U2P.SoundTable.PlaySlotSound( U2P, STS_FriendDead, true, SLOT_Dialog );
}

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

static function HandleHuntEnemy( U2Pawn U2P )
{
	if( FlavorTextIsValid( U2P, false ) )
		U2P.SoundTable.PlaySlotSound( U2P, STS_HuntEnemy, true, SLOT_Dialog );
}

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

static function HandleLostEnemy( U2Pawn U2P )
{
	if( FlavorTextIsValid( U2P, false ) )
		U2P.SoundTable.PlaySlotSound( U2P, STS_LostEnemy, true, SLOT_Dialog );
}

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

static function HandleFriendlyFire( U2Pawn Shooter, U2Pawn Victim )
{
	if( FRand() < 0.25 )
	{
		if( FlavorTextIsValid( Shooter, false ) )
			Shooter.SoundTable.PlaySlotSound( Shooter, STS_ShootFriendly, true, SLOT_Dialog );
	}
	else
	{
		if( FlavorTextIsValid( Victim, false ) )
			Victim.SoundTable.PlaySlotSound( Victim, STS_TakeFriendlyFire, true, SLOT_Dialog );
	}
}

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

static function sound HandleFriendlyPanicSound( U2Pawn U2P )
{
	if( U2P? && U2P.SoundTable? ) return U2P.SoundTable.PlaySlotSound( U2P, STS_TakeFriendlyFire, true, SLOT_Dialog );
	else return None;
}

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

static function HandleAcquireEnemySound( U2Pawn U2P )
{
	if( FlavorTextIsValid( U2P, false ) )
		U2P.SoundTable.PlaySlotSound( U2P, STS_Acquire, true, SLOT_Dialog );
}

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

static function HandleRandomAttackSound( U2Pawn U2P, SoundSlotInterf.ESoundTableSlot STSlot )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STSlot, true, SLOT_Dialog );
}

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

static function HandleRandomIdleSound( U2Pawn U2P, SoundSlotInterf.ESoundTableSlot STSlot )
{
	if( U2P? && U2P.SoundTable? ) U2P.SoundTable.PlaySlotSound( U2P, STSlot );
}

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

defaultproperties
{
	LandTextureHelperClass=Class'U2.LandTextureHelperGeneric'
	MoveTextureHelperClass=Class'U2.MoveTextureHelperGeneric'
	ProneTextureHelperClass=Class'U2.ProneTextureHelperGeneric'
	BodyLandTextureHelperClass=Class'U2.BodyLandTextureHelperGeneric'
}