src/StardewModdingAPI/Events/SaveEvents.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
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

using System;
using StardewModdingAPI.Framework;

namespace StardewModdingAPI.Events
{
    /// <summary>Events raised before and after the player saves/loads the game.</summary>
    public static class SaveEvents
    {
        /*********
        ** Events
        *********/
        /// <summary>Raised before the game begins writes data to the save file.</summary>
        public static event EventHandler BeforeSave;

        /// <summary>Raised after the game finishes writing data to the save file.</summary>
        public static event EventHandler AfterSave;

        /// <summary>Raised after the player loads a save slot.</summary>
        public static event EventHandler AfterLoad;

        /// <summary>Raised after the game returns to the title screen.</summary>
        public static event EventHandler AfterReturnToTitle;


        /*********
        ** Internal methods
        *********/
        /// <summary>Raise a <see cref="BeforeSave"/> event.</summary>
        /// <param name="monitor">Encapsulates monitoring and logging.</param>
        internal static void InvokeBeforeSave(IMonitor monitor)
        {
            monitor.SafelyRaisePlainEvent($"{nameof(SaveEvents)}.{nameof(SaveEvents.BeforeSave)}", SaveEvents.BeforeSave?.GetInvocationList(), null, EventArgs.Empty);
        }

        /// <summary>Raise a <see cref="AfterSave"/> event.</summary>
        /// <param name="monitor">Encapsulates monitoring and logging.</param>
        internal static void InvokeAfterSave(IMonitor monitor)
        {
            monitor.SafelyRaisePlainEvent($"{nameof(SaveEvents)}.{nameof(SaveEvents.AfterSave)}", SaveEvents.AfterSave?.GetInvocationList(), null, EventArgs.Empty);
        }

        /// <summary>Raise a <see cref="AfterLoad"/> event.</summary>
        /// <param name="monitor">Encapsulates monitoring and logging.</param>
        internal static void InvokeAfterLoad(IMonitor monitor)
        {
            monitor.SafelyRaisePlainEvent($"{nameof(SaveEvents)}.{nameof(SaveEvents.AfterLoad)}", SaveEvents.AfterLoad?.GetInvocationList(), null, EventArgs.Empty);
        }

        /// <summary>Raise a <see cref="AfterReturnToTitle"/> event.</summary>
        /// <param name="monitor">Encapsulates monitoring and logging.</param>
        internal static void InvokeAfterReturnToTitle(IMonitor monitor)
        {
            monitor.SafelyRaisePlainEvent($"{nameof(SaveEvents)}.{nameof(SaveEvents.AfterReturnToTitle)}", SaveEvents.AfterReturnToTitle?.GetInvocationList(), null, EventArgs.Empty);
        }
    }
}