1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-06-27 16:36:03 +00:00

Serialisation: documentation fixes, clarifying renames and whitespace fixes

1. Do two renames:
	* SER_FMT_CLIENT_VER_LOWEST -> SER_FMT_VER_LOWEST_WRITE
	* SER_FMT_VER_LOWEST -> SER_FMT_VER_LOWEST_READ
Now the two define values are consistently named with the _WRITE defines
SER_FMT_VER_{HIGHEST,LOWEST}_WRITE, and to better point out what the two
serialisation versions actually are for.

2. wrap some lines in doc/worldformat.txt, and point out that the node
timers are serialized at a later point, as this can cause confusion about
what now happens (if one doesn't strictly read the if block's conditions).

3. some whitespace fixes in NodeTimerList::serialize, and one new comment.
This commit is contained in:
est31 2015-09-14 06:02:41 +02:00
parent 915807f8db
commit 283bf97a1c
6 changed files with 23 additions and 20 deletions

View file

@ -45,9 +45,9 @@ void NodeTimer::deSerialize(std::istream &is)
void NodeTimerList::serialize(std::ostream &os, u8 map_format_version) const
{
if(map_format_version == 24){
if (map_format_version == 24) {
// Version 0 is a placeholder for "nothing to see here; go away."
if(m_data.empty()){
if (m_data.empty()) {
writeU8(os, 0); // version
return;
}
@ -55,18 +55,18 @@ void NodeTimerList::serialize(std::ostream &os, u8 map_format_version) const
writeU16(os, m_data.size());
}
if(map_format_version >= 25){
writeU8(os, 2+4+4);
if (map_format_version >= 25) {
writeU8(os, 2 + 4 + 4); // length of the data for a single timer
writeU16(os, m_data.size());
}
for(std::map<v3s16, NodeTimer>::const_iterator
for (std::map<v3s16, NodeTimer>::const_iterator
i = m_data.begin();
i != m_data.end(); ++i){
i != m_data.end(); ++i) {
v3s16 p = i->first;
NodeTimer t = i->second;
u16 p16 = p.Z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + p.Y*MAP_BLOCKSIZE + p.X;
u16 p16 = p.Z * MAP_BLOCKSIZE * MAP_BLOCKSIZE + p.Y * MAP_BLOCKSIZE + p.X;
writeU16(os, p16);
t.serialize(os);
}
@ -75,7 +75,7 @@ void NodeTimerList::serialize(std::ostream &os, u8 map_format_version) const
void NodeTimerList::deSerialize(std::istream &is, u8 map_format_version)
{
m_data.clear();
if(map_format_version == 24){
u8 timer_version = readU8(is);
if(timer_version == 0)