using System;

using Framework.Services;

namespace Framework.Actors.Shooter {

  /// <summary>Stores moves a player character can execute</summary>
  /// <remarks>
  ///   <para>
  ///     This component can be added to an actor in order to support both caching
  ///     of moves and use of modified moves.
  ///   </para>
  ///   <para>
  ///     For example, to override the 'air' move (maybe to implement jetpack functionality
  ///     or special animations), you would derive your own class from the 'PlayerMoveRepository'
  ///     and override the <see cref="SelectAirMove" /> method to instead return your special
  ///     air move implementation. The standard 'ground' move will, upon detecting the 'jump'
  ///     key, switch to the 'air' move through the repository, thus activating your special
  ///     air move implementation.
  ///   </para>
  /// </remarks>
  public class PlayerMoveRepository : ScriptComponent {

    /// <summary>Returns and configures the move for ground-based movement</summary>
    /// <param name="impactVelocity">Downward velocity with which the ground was hit</param>
    /// <returns>The move that should be used for ground movement</returns>
    /// <remarks>
    ///   The impact velocity can be safely ignored but allows for additional realism,
    ///   for example by using different "landing" animations for different impact strengths
    ///   or even deciding whether the actor should die rather than safely land.
    /// </remarks>
    public virtual Move GetGroundMove(float impactVelocity = 0.0f) {
      if(this.groundMove == null) {
        this.groundMove = new GroundMove();
      }

      return this.groundMove;
    }

    /// <summary>Returns and configures the move for movement through the air</summary>
    /// <param name="jumped">Whether the character has jumped</param>
    /// <returns>The move that should be used for air movement</returns>
    public virtual Move GetAirMove(bool jumped = false) {
      if(this.airMove == null) {
        this.airMove = new AirMove();
      }

      this.airMove.WasActivatedByJumping = jumped;
      return this.airMove;
    }

    /// <summary>Move for controlling the actor on the ground</summary>
    private GroundMove groundMove;
    /// <summary>Move for controlling the actor in the air</summary>
    private AirMove airMove;

  }

} // namespace Framework.Actors.Shooter