summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/SaveEvents.cs
blob: 5b83efc84be7d0cb1f5562a8869b0c2b02055975 (plain)
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
using System;
using StardewModdingAPI.Framework;
using StardewModdingAPI.Framework.Events;

namespace StardewModdingAPI.Events
{
    /// <summary>Events raised before and after the player saves/loads the game.</summary>
    [Obsolete("Use " + nameof(Mod.Helper) + "." + nameof(IModHelper.Events) + " instead. See https://smapi.io/3.0 for more info.")]
    public static class SaveEvents
    {
        /*********
        ** Properties
        *********/
        /// <summary>The core event manager.</summary>
        private static EventManager EventManager;

        /// <summary>Manages deprecation warnings.</summary>
        private static DeprecationManager DeprecationManager;


        /*********
        ** Events
        *********/
        /// <summary>Raised before the game creates the save file.</summary>
        public static event EventHandler BeforeCreate
        {
            add
            {
                SaveEvents.DeprecationManager.WarnForOldEvents();
                SaveEvents.EventManager.Legacy_BeforeCreateSave.Add(value);
            }
            remove => SaveEvents.EventManager.Legacy_BeforeCreateSave.Remove(value);
        }

        /// <summary>Raised after the game finishes creating the save file.</summary>
        public static event EventHandler AfterCreate
        {
            add
            {
                SaveEvents.DeprecationManager.WarnForOldEvents();
                SaveEvents.EventManager.Legacy_AfterCreateSave.Add(value);
            }
            remove => SaveEvents.EventManager.Legacy_AfterCreateSave.Remove(value);
        }

        /// <summary>Raised before the game begins writes data to the save file.</summary>
        public static event EventHandler BeforeSave
        {
            add
            {
                SaveEvents.DeprecationManager.WarnForOldEvents();
                SaveEvents.EventManager.Legacy_BeforeSave.Add(value);
            }
            remove => SaveEvents.EventManager.Legacy_BeforeSave.Remove(value);
        }

        /// <summary>Raised after the game finishes writing data to the save file.</summary>
        public static event EventHandler AfterSave
        {
            add
            {
                SaveEvents.DeprecationManager.WarnForOldEvents();
                SaveEvents.EventManager.Legacy_AfterSave.Add(value);
            }
            remove => SaveEvents.EventManager.Legacy_AfterSave.Remove(value);
        }

        /// <summary>Raised after the player loads a save slot.</summary>
        public static event EventHandler AfterLoad
        {
            add
            {
                SaveEvents.DeprecationManager.WarnForOldEvents();
                SaveEvents.EventManager.Legacy_AfterLoad.Add(value);
            }
            remove => SaveEvents.EventManager.Legacy_AfterLoad.Remove(value);
        }

        /// <summary>Raised after the game returns to the title screen.</summary>
        public static event EventHandler AfterReturnToTitle
        {
            add
            {
                SaveEvents.DeprecationManager.WarnForOldEvents();
                SaveEvents.EventManager.Legacy_AfterReturnToTitle.Add(value);
            }
            remove => SaveEvents.EventManager.Legacy_AfterReturnToTitle.Remove(value);
        }


        /*********
        ** Public methods
        *********/
        /// <summary>Initialise the events.</summary>
        /// <param name="eventManager">The core event manager.</param>
        /// <param name="deprecationManager">Manages deprecation warnings.</param>
        internal static void Init(EventManager eventManager, DeprecationManager deprecationManager)
        {
            SaveEvents.EventManager = eventManager;
            SaveEvents.DeprecationManager = deprecationManager;
        }
    }
}