Publicize CurrentRestMode

[jefetienne]

This is for issue #1962.

This PR essentially would replace the utility of PlayerEntity.IsLoitering and PlayerEntity.IsResting, but may be kept for mod compatibility reasons. I also have no problem with removing them if requested. :)

I publicized the RestModes enum and kept it in DaggerfallRestWindow, but I can move it elsewhere to DaggerfallUnityEnums if mod compatibility is also not an issue.

[Interkarma]

I'm happy to leave in IsLoitering and IsResting for overall compatibility. Thank you for fix! :)

[petchema]

I'm currently tracking some regression:
When trying to sleep (say at night, to increase the likeliness of an encounter) and get interrupted, getting out of enemy reach and trying to rest again, instead of having to choose a resting option, you immediately get a "You wake up." message on top of a countdown at 0

A second attempt works fine.

And git bisect points at commit 29e2616

[petchema]

Test game save, if you need one
SAVE871.zip

(thinking of it, it may not be the best save, it's in the middle of the ocean thanks to an issue with Interesting Terrains!)

[Interkarma]

Maybe the removal of protected RestModes currentRestMode = RestModes.Selection;? This default no longer appears to be set anywhere.

If not, should we create a quick issue for this one? I'm starting to unplug a little for Christmas and don't want to lose track.

[jefetienne]

I think the issue is because when the window is pushed, it may still be using the last rest mode stored in GameManager because of an interruption. I'll take a look at it.

[petchema]

That was my guess too, but I'm not sure how to emulate that back with a property.
I did

diff --git a/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs b/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs
index c359ac45c..273777315 100644
--- a/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs
+++ b/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs
@@ -116,6 +116,7 @@ namespace DaggerfallWorkshop.Game.UserInterfaceWindows
             : base(uiManager)
         {
             this.ignoreAllocatedBed = ignoreAllocatedBed;
+            currentRestMode = RestModes.Selection;
         }
 
         #endregion

and it seems to work...

[jefetienne]

That was my guess too, but I'm not sure how to emulate that back with a property.
I did

diff --git a/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs b/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs
index c359ac45c..273777315 100644
--- a/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs
+++ b/Assets/Scripts/Game/UserInterfaceWindows/DaggerfallRestWindow.cs
@@ -116,6 +116,7 @@ namespace DaggerfallWorkshop.Game.UserInterfaceWindows
             : base(uiManager)
         {
             this.ignoreAllocatedBed = ignoreAllocatedBed;
+            currentRestMode = RestModes.Selection;
         }
 
         #endregion

and it seems to work...

I think maybe putting it in OnPush() might be better? I forget how often the methods Start(), Setup() and the Constructor() are called when opening the window multiple times, but I know OnPush() is every time.

[petchema]

Well, I think removed line

protected RestModes currentRestMode = RestModes.Selection;

was only executed once too, when the window was built...
I'm not sure if setting it explicitly in the constructor is "correct", but I think it should be equivalent to what was there before

[petchema]

If not, should we create a quick issue for this one? I'm starting to unplug a little for Christmas and don't want to lose track.

I created a PR

[Interkarma]

Great work, thank you @petchema and @jefetienne.