using System;

namespace Framework.Storage.Containers {
  
  /// <summary>Default interface for an achievement container</summary>
  /// <remarks>
  ///   This interface should be implemented by your game-specific achievement container
  ///   so generic achievement handling tools, UIs and triggers can access achivements
  ///   without having to be reimplement for each specific game.  
  /// </remarks>
  public interface IAchievements {

    /// <summary>Triggers whenever an achievement is granted to the player</summary>
    /// <remarks>
    ///   This event can be hooked to display an achievement overlay.
    /// </remarks>
    event Action<string> AchievementGained;

    /// <summary>Checks whether the player has unlocked a specified achievements</summary>
    /// <param name="name">Name of the achievement that will be checked</param>
    /// <returns>True if the achievment has been unlocked, false otherwise</returns>
    bool HasAchievement(string name);

    /// <summary>Unlocks an achievement for the player</summary>
    /// <param name="name">Name of the achievement that will unlocked</param>
    void GrantAchievement(string name);

    /// <summary>Clears all achievements</summary>
    void ResetAllAchievements();

  }
  
} // namespace Framework.Storage.Containers