using System;

namespace Framework.Services {

  /// <summary>In what scope a service will live</summary>
  public enum Scope {

    /// <summary>The instance remains around until the scene changes</summary>
    /// <remarks>
    ///    Useful for things that should be reset when the scene changes, such
    ///    as enemy coordinators, scene event managers, crowd directors, etc.
    /// </remarks>
    Scene = 0,

    /// <summary>The instance remains for one playthrough</summary>
    /// <remarks>
    ///   This would be used for components that need to remain available when
    ///   moving between scenes, but get destroyed when quitting to the main
    ///   menu. A typical case would be a component that stores the inventory
    ///   of the player.
    /// </remarks>
    Session = 1,

    /// <summary>One instance that exists for as long as the game runs</summary>
    /// <remarks>
    ///   For game-wide services that are kept around regardless of what the player
    ///   does. Components storing the game's key bindings, achievements and such
    ///   would be ideal candidates for this.
    /// </remarks>
    Global = 2

  }

} // namespace Framework.Services