#region Copyright & License Information
/*
 * Copyright 2007-2015 The OpenRA Developers (see AUTHORS)
 * This file is part of OpenRA, which is free software. It is made
 * available to you under the terms of the GNU General Public License
 * as published by the Free Software Foundation. For more information,
 * see COPYING.
 */
#endregion

using OpenRA.Traits;

namespace OpenRA.Mods.Common.Traits
{
	[Desc("Plays a looping audio file at the actor position. Attach this to the `World` actor to cover the whole map.")]
	class AmbientSoundInfo : UpgradableTraitInfo
	{
		[FieldLoader.Require]
		public readonly string SoundFile = null;

		[Desc("Interval between playing the sound (in ticks).")]
		public readonly int Interval = 0;

		public override object Create(ActorInitializer init) { return new AmbientSound(init.Self, this); }
	}

	class AmbientSound : UpgradableTrait<AmbientSoundInfo>, ITick
	{
		ISound currentSound;
		bool wasDisabled = true;
		int interval;

		public AmbientSound(Actor self, AmbientSoundInfo info)
			: base(info)
		{
			interval = info.Interval;
		}

		public void Tick(Actor self)
		{
			if (IsTraitDisabled)
			{
				Game.Sound.StopSound(currentSound);
				currentSound = null;
				wasDisabled = true;
				return;
			}

			if (wasDisabled && Info.Interval <= 0)
			{
				if (self.OccupiesSpace != null)
					currentSound = Game.Sound.PlayLooped(Info.SoundFile, self.CenterPosition);
				else
					currentSound = Game.Sound.PlayLooped(Info.SoundFile);
			}

			wasDisabled = false;

			if (Info.Interval <= 0)
				return;

			if (interval-- > 0)
				return;

			interval = Info.Interval;

			if (self.OccupiesSpace != null)
				Game.Sound.Play(Info.SoundFile, self.CenterPosition);
			else
				Game.Sound.Play(Info.SoundFile);
		}
	}
}