using System;

using Framework.Services;

namespace Framework.State {

  /// <summary>Can be implemented by a component to make it user-controllable</summary>
  public interface IControllable {

    /// <summary>Triggered when control of the game object is being taken</summary>
    event Action<int> ControlTaken;
    /// <summary>Triggered when control of the game object has been released</summary>
    event Action<int> ControlReleased;

    /// <summary>Called when the player takes control of the controllable</summary>
    /// <param name="playerIndex">Index of the player that has taken control</param>
    void OnTakeControl(int playerIndex);

    /// <summary>Called when the player releases control of the controllable</summary>
    /// <param name="playerIndex">Index of the player that has released control</param>
    void OnReleaseControl(int playerIndex);

    /// <summary>Index of the player currently in control, -1 for none</summary>
    int ControllingPlayerIndex { get; }

  }

} // namespace Framework.State