[WIP] Unit tests for creating save data

[CG-Tespy]

Description

I felt we need to solidify more of the more basic stuff, such as creating save data of specific types, starting with the numeric Fungus Variables that Flowcharts can have.

Important Notes

• I have the unit tests work by loading prefab scenes placed somewhere in the main Test folder. Said tests then using the prefabs' contents to do their thing. It's a pattern I've found more useful (and more fun) than having to set up scenes entirely in code.
• I felt it'd be good to have the encoders be MonoBehaviors so that users can swap them in and out as they see fit, hence what you see attached to the FlowchartEncoders GameObject
  • After all, what if the user wants to change how the built-in data types are saved? I believe it's best to give them that option by
  • This would also mean that the main FlowchartEncoder (not yet coded in) would have to be told which GameObjects contain its subencoders, allowing for more organization
• My change adds tests or test scenes
  • Naturally
• From what I've gathered from reverse-engineering this system, StringPairs are intended to be the main containers of off-disk saves. Hence why the encoder returns instances of those
• For the sake of the SRP, I felt it's be best to have various types have their own encoders, hence the NumericVarSaveEncoder class for the numeric Fungus Vars
• Before becoming an official collaborator on Fungus, I did a little work on saving sound-related data. You can ignore that stuff involved in this PR; it'll likely get replaced by other code later down the line

Main To-Do List

• Saving the following essential var types: (done!)
  • Numerics (ints, floats, bools)
  • String
  • Color
  • Vectors (2D, 3D, 4D)
  • Transform
• Saving the state of Fungus's Portrait system (done!)
  • What portraits were shown at the time the game was saved
• Refine the implementation as appropriate
• Saving the execution states of Flowcharts (done!)
  • The execution counts of the blocks
  • The execution counts of Say Command
• Keeping the states of the Menu blocks. Problem mentioned in #921 (done!)
  • Hide If Visited
  • Interactable
  • Hide This Option

Secondary To-Do List

• Saving the following (not quite as essential) var types:
  • Rigidbodies (2D, 3D)
  • Sound Clip
  • Audio Source
  • Quaternion
• Saving the state of the Fungus's Audio system
  • What BGM and Ambient sounds were playing
  • May need to wait on further implementation before starting on this
• Saving the states of the following commands
  • Menu (done!)
  • Say (done!)
  • Has a counter for how many times it should show
  • Various Tweens
  • Saving the state of the current view

[CG-Tespy]

What do you think, @stevehalliwell ?

[CG-Tespy]

Added a to-do list

[stevehalliwell]

All for more tests. There is already some existing tests in fungus that load prefabs as a unit test, so there's some good reuse/refactor there.

Many of the things in the list exist and have integration tests or demo scenes right now so they can be expanded to self validate and throw.

On the types supported, don't have to support everything out of the box but the underlying system and interfaces should allow more types to be added in the future (by us or by any one else). Also I Fungus save should save Fungus stuff first and foremost, things like remembering which music track was playing are nice to haves but at the moment not entirely controlled by Fungus, (it's not a Fungus system, it's just passing an audio clip ref along to Unity).

The solve I would want to see for music is, introduce the concept of tracks, and playlists to Fungus, then saving and loading is trivial as the system is entirely Fungus data, but that (and other elements) are beyond the scope of this feature.

[CG-Tespy]

@stevehalliwell

Many of the things in the list exist and have integration tests or demo scenes right now so they can be expanded to self validate and throw.

Hmm, then I think it'd be best to have them separated into their own suites for the sake of better organization, much like how I have things now. Can you handle that, please?

On the types supported, don't have to support everything out of the box Yeah, especially since some things aren't really essential

...but the underlying system and interfaces should allow more types to be added in the future (by us or by any one else).

Yes, that's pretty core to the save system's design right now ^^ I'm applying an approach pretty similar to what our View system has: a plug-and-play approach that lets the user easily insert and remove parts of the system

The solve I would want to see for music is, introduce the concept of tracks, and playlists to Fungus, then saving and loading is trivial as the system is entirely Fungus data, but that (and other elements) are beyond the scope of this feature.

I think I see what you mean... And I think that the track system you're suggesting will need to be implemented and tested before the save system can really be set up to work with it

[CG-Tespy]

At the time of this writing, we have things set up to save nearly all the essential var types.

[CG-Tespy]

While there's still stuff on the secondary to-do list, I think I've done enough work here to move onto another area of the save system for now