V3/Data/IPathManager.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

namespace V3.Data
{
    /// <summary>
    /// Provides access to the default applications path, i. e. the
    /// directories where save games, achievements and other persistent data
    /// can be stored.
    /// </summary>
    public interface IPathManager
    {
        /// <summary>
        /// The base directory for persistent application data.
        /// </summary>
        string AppDirectory { get; }

        /// <summary>
        /// The directory for save games.
        /// </summary>
        string SaveGameDirectory { get; }

        /// <summary>
        /// The file to store the options in.
        /// </summary>
        string OptionsFile { get;  }

        /// <summary>
        /// Creates the application directories that do not already exist.
        /// </summary>
        void CreateMissingDirectories();
    }
}