summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/PlayerEvents.cs
blob: 4f5f4a373c07c53579ac498e60eef05ae565110c (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
using System;
using StardewModdingAPI.Framework;
using StardewModdingAPI.Framework.Events;

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

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


        /*********
        ** Events
        *********/
        /// <summary>Raised after the player's inventory changes in any way (added or removed item, sorted, etc).</summary>
        public static event EventHandler<EventArgsInventoryChanged> InventoryChanged
        {
            add
            {
                PlayerEvents.DeprecationManager.WarnForOldEvents();
                PlayerEvents.EventManager.Legacy_InventoryChanged.Add(value);
            }
            remove => PlayerEvents.EventManager.Legacy_InventoryChanged.Remove(value);
        }

        /// <summary>Raised after the player levels up a skill. This happens as soon as they level up, not when the game notifies the player after their character goes to bed.</summary>
        public static event EventHandler<EventArgsLevelUp> LeveledUp
        {
            add
            {
                PlayerEvents.DeprecationManager.WarnForOldEvents();
                PlayerEvents.EventManager.Legacy_LeveledUp.Add(value);
            }
            remove => PlayerEvents.EventManager.Legacy_LeveledUp.Remove(value);
        }

        /// <summary>Raised after the player warps to a new location.</summary>
        public static event EventHandler<EventArgsPlayerWarped> Warped
        {
            add
            {
                PlayerEvents.DeprecationManager.WarnForOldEvents();
                PlayerEvents.EventManager.Legacy_PlayerWarped.Add(value);
            }
            remove => PlayerEvents.EventManager.Legacy_PlayerWarped.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)
        {
            PlayerEvents.EventManager = eventManager;
            PlayerEvents.DeprecationManager = deprecationManager;
        }
    }
}