Changes

===Is this the modapocalypse?===

===Is this the modapocalypse?===

Nope. Although this is a major change, significant effort were undertaken to minimise the impact:

Nope. Although this is a major change, significant efforts were undertaken to minimize the impact:

* the old events were supported for a long time with increasingly prominent warnings in the SMAPI console about their deprecation and removal;

* the old events were supported for a long time with increasingly prominent warnings in the SMAPI console about their deprecation and removal;

* pull requests were submitted to update affected open-source mods;

* pull requests were submitted to update affected open-source mods;

* unofficial updates were created for mods which haven't updated officially by the time SMAPI 3.0 is released;

* unofficial updates were created for mods which haven't updated officially by the time SMAPI 3.0 is released;

* the changes was actively communicated and documented to modders.

* the changes were actively communicated and documented to modders.

In addition, the current target is ''at least'' 95% compatibility for open-source mods before SMAPI 3.0 is released. All of this means that the 3.0 release should have minimal impact on mod compatibility, despite the scope of the changes.

In addition, the current target is ''at least'' 95% compatibility for open-source mods before SMAPI 3.0 is released. All of this means that the 3.0 release should have minimal impact on mod compatibility, despite the scope of the changes.

  |old events = GraphicsEvents.OnPostRenderEvent

  |old events = GraphicsEvents.OnPostRenderEvent

  |new events = Display.Rendered

  |new events = Display.Rendered

  |summary    = Equivalent, except the new event isn't triggered during certain special cutscenes and minigames (e.g. the [[Sebastian#Six Hearts|board game scene]]).

  |summary    = Equivalent, except the new event isn't triggered during certain special cutscenes and minigames (''e.g.,'' the [[Sebastian#Six Hearts|board game scene]]).

}}

}}

{{/event

{{/event

  |old events = MenuEvents.MenuChanged, MenuEvents.MenuClosed

  |old events = MenuEvents.MenuChanged, MenuEvents.MenuClosed

  |new events = Display.MenuChanged

  |new events = Display.MenuChanged

  |summary    = These caused a lot of confusion (e.g. <samp>MenuEvents.MenuClosed</samp> wasn't called when a menu was closed and immediately replaced), so they've been combined into one event which is called when a menu is opened, closed, or replaced. You can check the <samp>e.OldMenu</samp> and <samp>e.NewMenu</samp> event args to know what the change is (e.g. to match the old <samp>MenuEvents.MenuClosed</samp>, check <code>if (e.NewMenu == null)</code>).

  |summary    = These caused a lot of confusion (''e.g.,'' <samp>MenuEvents.MenuClosed</samp> wasn't called when a menu was closed and immediately replaced), so they've been combined into one event which is called when a menu is opened, closed, or replaced. You can check the <samp>e.OldMenu</samp> and <samp>e.NewMenu</samp> event args to know what the change is (''e.g.,'' to match the old <samp>MenuEvents.MenuClosed</samp>, check <code>if (e.NewMenu == null)</code>).

}}

}}

{{/event

{{/event