using System;

using Framework.Services;

namespace Framework.Layers {

  /// <summary>Manages layer masks that can be used to check collisions</summary>
  [
    ServiceScope(Scope.Global),
    DefaultBinding(typeof(LayerMaskManager))
  ]
  public interface ILayerMaskService {

    /// <summary>
    ///   Looks up the default collision mask for the layer with the specified name
    /// </summary>
    /// <param name="layerName">
    ///   Name of the layer whose collision mask will be looked up
    /// </param>
    /// <returns>The default collision mask for the layer with the specified name</returns>
    int GetDefaultMask(string layerName);

    /// <summary>Retrieves one of the configured layer masks by its name</summary>
    /// <param name="layerMaskName">Name of the layer mask that will be retrieved</param>
    /// <returns>The layer mask with the specified name</returns>
    int GetMask(string layerMaskName);

    /// <summary>Changes one of the configured layer masks</summary>
    /// <param name="layerMaskName">Name of the layer mask that will be changed</param>
    /// <param name="mask">New layer mask to store under that given name</param>
    void SetMask(string layerMaskName, int mask);

  }

} // namespace Framework.Layers