adam/cobm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update savefile spec based on new findings.

Browse Source
This commit is contained in:
Michael Martin
2013-10-13 23:22:20 -07:00
parent 60a9ca61cf
commit 9f3a70985e
1 changed files with 32 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
sc2/doc/devel/savefile
+28 -11
View File
@@ -119,27 +119,44 @@ save file.
encounters in interplanetary space. See doc/devel/statefiles for encounters in interplanetary space. See doc/devel/statefiles for
more details. more details.
- "Scan": Scanner Masks. NOT YET IMPLEMENTED; WILL REPLACE SISF. It
might just be a rename with better endianness enforcement, though;
the SISF dump is pretty well-structured as it is.
- "DGrp": Defined Group. NOT YET IMPLEMENTED; WILL REPLACE DGSF. Will
carry an enumeration id to indicate which of the defgrps it is
(that's currently intrinsic to the game state bit array) and will
also have a bit indicating whether or not it is the "current"
defgrp. If no defgrp is current, BattleGroupRef is 0; otherwise,
BattleGroupRef is the defgrp file offset that corresponds to the
current system. There will be one DGrp chunk for each system with an
active defgrp record.
- NOT YET DESIGNED: RGSF also needs to be replaced with one or more
chunk types. This will likely be similar to the DGrp chunks, but
there are stronger constraints on repetition here.
THINGS LEFT TO DO BEFORE MERGING THINGS LEFT TO DO BEFORE MERGING
-------------------------------- --------------------------------
- Actually enforce little-endianness of everything that hits the disk. - Actually enforce little-endianness of everything that hits the disk.
- This is a simple matter of improving the read_* and write_* - Everything that isn't a State File now respects this.
functions in load.c and save.c. - State files are going to require more work (see below).
- There are 448 bits in GmSt that are actually indices into DGSF. They - There are 448 bits in GmSt that are actually indices into DGSF. They
shouldn't be there. In fact, they shouldn't even be in the shouldn't be there. In fact, they shouldn't even be in the
GAME_STATE array either. They should be an array of DWORDs living GAME_STATE array either. They should be an array of DWORDs living
independently in the global state independently in the global state
- First, we should juggle the order of the state bits so that - In preparation for this, the GRPOFFS state has been moved to the
they're all at the end. That way we can ultimately just truncate end of the state array. We'll be able to eradicate it once the
GmSt and everything will be fine. We can do that without state files are no longer part of the save.
complicating legacy loads much.
- The State Files are (except maybe for Star Info) a horrible mess and - The State Files are (except maybe for Star Info) a horrible mess and
we should not be replicating them in the save file. We should we should not be replicating them in the save file. We should
instead be regenerating them from more structured forms. instead be regenerating them from more structured forms.
- This is complicated by the fact that there are references to the - Once we do this we can start computing new values for the GRPOFFS
_GSF chunks in both GlSt (BattleGroupRef) and GmSt state and the BattleGroupRef based on the new chunks. We can then
(*_GRPOFFSET*). I have a good handle on what needs to be done to remove the GRPOFFS bits from the GmSt chunk and the BattleGroupRef
GmSt, but the significance of the GlSt pointer still requires from the GlSt chunk. From there we can see our way to eradicating
research. the state file abstraction entirely, but that will be quite a bit
more work.