Saving mod data to sfs files

[MarkusA380]

Hello there!

I've been working on my mod, PersistentRotation, for quite a long time. If you never heard of it make sure to check it out, to know what I am talking about.

The mod is currently saving it's data into a custom made cfg file. Every time the game quicksaves or switches scenes, a new file is generated.

While I have added code to clean up deprecated versions of the file, I still have the feeling that it isn't the optimal solution to store the data.

A while ago, I have heard about saving mod data to the game's sfs files. This would of course be a a lot more effective way of storing data.

Now, the problem is, my mod saves data per vessel and has no custom parts at all.

Could someone explain me how to do this or send me the corrseponding piece of code?

Thanks in advance.

[MarkusA380]

So I've found [KSPField(isPersistant = false) in MechJeb's source code.

But that only works for part modules, right?

[Boris-Barboris]

VesselModule may be helpful as a simple storage wrapper, when filled with persistent KSPFields.

 

[MarkusA380]

55 minutes ago, Boris-Barboris said:

VesselModule may be helpful as a simple storage wrapper, when filled with persistent KSPFields.

 

Do you have any examples or a post that explains how to? I found nothing.

[nathan1]

You could just move the data into a Scenario (which KSP will save into the persistent.sfs file) instead of manually saving it into a separate file. Many mods save their data in a Scenario like this (AltFunding which I made does this, USI Life Support by RoverDude does, SCANSat does, etc).

The things to look for are subclasses of ScenarioModule and calls to Game.AddProtoScenarioModule().

I've never used VesselModules, but converting to use that would probably be a bigger change (but I also suspect it would be a better approach in the long-term since your data really is specifically tied to each vessel and not just generic per-save information).

Edit: I had assumed VesselModule can persist data the same way PartModule does, but the post Boris linked above says that VesselModule itself provides no facilities for persistence. If so, then ScenarioModule is what you'll want.

Edited September 5, 2016 by nathan1