Skip to content

Commit 2b6e9f1

Browse files
KillerooKilleroo
committed
Fixed bad namespace in PrebuiltNetworkSubfile.cs
Renamed xml comment instances of 'DataStructures'
1 parent 21f2fd7 commit 2b6e9f1

File tree

4 files changed

+36
-34
lines changed

4 files changed

+36
-34
lines changed

‎SC4Parser/Files/SC4SaveFile.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,7 @@ public NetworkSubfile2 GetNetworkSubfile2()
697697
/// </c>
698698
/// </example>
699699
/// <seealso cref="SC4Parser.Subfiles.PrebuiltNetworkSubfile"/>
700-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile"/>
700+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile"/>
701701
public PrebuiltNetworkSubfile GetPrebuiltNetworkSubfile()
702702
{
703703
if (m_CachedPrebuiltNetworkSubfile != null)

‎SC4Parser/Structures/PrebuiltNetworkTile.cs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
using System;
22
using System.Collections.Generic;
33

4-
using SC4Parser.Types;
4+
using SC4Parser;
55

6-
namespace SC4Parser.DataStructures
6+
namespace SC4Parser.Structures
77
{
88
/// <summary>
99
/// Representation of a city's network tiles which are found in Network Subfile 1.
@@ -16,8 +16,8 @@ namespace SC4Parser.DataStructures
1616
/// Implemented from https://wiki.sc4devotion.com/index.php?title=Network_Subfiles#Network_Subfile_1_Structure
1717
/// </remarks>
1818
/// <see cref="SC4Parser.Subfiles.PrebuiltNetworkSubfile"/>
19-
/// <seealso cref="SC4Parser.DataStructures.NetworkBlock"/>
20-
/// <seealso cref="SC4Parser.DataStructures.NetworkTile2"/>
19+
/// <seealso cref="SC4Parser.Structures.NetworkBlock"/>
20+
/// <seealso cref="SC4Parser.Structures.NetworkTile2"/>
2121
public class PrebuiltNetworkTile
2222
{
2323
/// <summary>
@@ -80,12 +80,12 @@ public class PrebuiltNetworkTile
8080
/// <summary>
8181
/// Number of save game properties (sigprops) attached to the network tile
8282
/// </summary>
83-
/// <see cref="SC4Parser.DataStructures.SaveGameProperty"/>
83+
/// <see cref="SC4Parser.Structures.SaveGameProperty"/>
8484
public uint SaveGamePropertyCount { get; private set; }
8585
/// <summary>
8686
/// Network tile save game properties (if any)
8787
/// </summary>
88-
/// <see cref="SC4Parser.DataStructures.SaveGameProperty"/>
88+
/// <see cref="SC4Parser.Structures.SaveGameProperty"/>
8989
public List<SaveGameProperty> SaveGamePropertyEntries { get; private set; } = new List<SaveGameProperty>();
9090
/// <summary>
9191
/// Network tile's Group ID
@@ -119,47 +119,47 @@ public class PrebuiltNetworkTile
119119
/// <remarks>
120120
/// This seems to be a quarter of the network tile's actual size
121121
/// </remarks>
122-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MinSizeX2"/>
122+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MinSizeX2"/>
123123
public float MinSizeX1 { get; private set; }
124124
/// <summary>
125125
/// Maximum x size of the Network tile (first set of sizes)
126126
/// </summary>
127127
/// <remarks>
128128
/// This seems to be a quarter of the network tile's actual size
129129
/// </remarks>
130-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MaxSizeX2"/>
130+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MaxSizeX2"/>
131131
public float MaxSizeX1 { get; private set; }
132132
/// <summary>
133133
/// Minimum y size of the Network tile (first set of sizes)
134134
/// </summary>
135135
/// <remarks>
136136
/// This to be a quarter of the network tile's size
137137
/// </remarks>
138-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MinSizeY2"/>
138+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MinSizeY2"/>
139139
public float MinSizeY1 { get; private set; }
140140
/// <summary>
141141
/// Maximum y size of the Network tile (first set of sizes)
142142
/// </summary>
143143
/// <remarks>
144144
/// This seems to be a quarter of the network tile's actual size
145145
/// </remarks>
146-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MaxSizeY2"/>
146+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MaxSizeY2"/>
147147
public float MaxSizeY1 { get; private set; }
148148
/// <summary>
149149
/// Minimum z size of the Network tile (first set of sizes)
150150
/// </summary>
151151
/// <remarks>
152152
/// This seems to be a quarter of the network tile's actual size
153153
/// </remarks>
154-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MinSizeZ2"/>
154+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MinSizeZ2"/>
155155
public float MinSizeZ1 { get; private set; }
156156
/// <summary>
157157
/// Maximum z size of the Network tile (first set of sizes)
158158
/// </summary>
159159
/// <remarks>
160160
/// This seems to be a quarter of the network tile's actual size
161161
/// </remarks>
162-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MaxSizeZ2"/>
162+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MaxSizeZ2"/>
163163
public float MaxSizeZ1 { get; private set; }
164164

165165
/// <summary>
@@ -278,47 +278,47 @@ public class PrebuiltNetworkTile
278278
/// <remarks>
279279
/// This seems to be a quarter of the network tile's actual size
280280
/// </remarks>
281-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MinSizeX1"/>
281+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MinSizeX1"/>
282282
public float MinSizeX2;
283283
/// <summary>
284284
/// Maximum x size of the Network tile (second set of sizes)
285285
/// </summary>
286286
/// <remarks>
287287
/// This seems to be a quarter of the network tile's actual size
288288
/// </remarks>
289-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MaxSizeX1"/>
289+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MaxSizeX1"/>
290290
public float MaxSizeX2;
291291
/// <summary>
292292
/// Minimum y size of the Network tile (second set of sizes)
293293
/// </summary>
294294
/// <remarks>
295295
/// This seems to be a quarter of the network tile's actual size
296296
/// </remarks>
297-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MinSizeY1"/>
297+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MinSizeY1"/>
298298
public float MinSizeY2;
299299
/// <summary>
300300
/// Maximum y size of the Network tile (second set of sizes)
301301
/// </summary>
302302
/// <remarks>
303303
/// This seems to be a quarter of the network tile's actual size
304304
/// </remarks>
305-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MaxSizeY1"/>
305+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MaxSizeY1"/>
306306
public float MaxSizeY2;
307307
/// <summary>
308308
/// Minimum z size of the Network tile (second set of sizes)
309309
/// </summary>
310310
/// <remarks>
311311
/// This seems to be a quarter of the network tile's actual size
312312
/// </remarks>
313-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MinSizeZ1"/>
313+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MinSizeZ1"/>
314314
public float MinSizeZ2;
315315
/// <summary>
316316
/// Maximum z size of the Network tile (second set of sizes)
317317
/// </summary>
318318
/// <remarks>
319319
/// This seems to be a quarter of the network tile's actual size
320320
/// </remarks>
321-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile.MaxSizeZ1"/>
321+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile.MaxSizeZ1"/>
322322
public float MaxSizeZ2;
323323

324324
/// <summary>

‎SC4Parser/SubFiles/NetworkIndex.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ public class NetworkTileReference
2929
/// <summary>
3030
/// Memory address of the network tile
3131
/// </summary>
32-
/// <see cref="SC4Parser.DataStructures.NetworkTile1.Memory"/>
33-
/// <see cref="SC4Parser.DataStructures.NetworkTile2.Memory"/>
34-
/// <see cref="SC4Parser.DataStructures.PrebuiltNetworkTile.Memory"/>
35-
/// <see cref="SC4Parser.DataStructures.BridgeNetworkTile.Memory"/>
32+
/// <see cref="SC4Parser.Structures.NetworkTile1.Memory"/>
33+
/// <see cref="SC4Parser.Structures.NetworkTile2.Memory"/>
34+
/// <see cref="SC4Parser.Structures.PrebuiltNetworkTile.Memory"/>
35+
/// <see cref="SC4Parser.Structures.BridgeNetworkTile.Memory"/>
3636
public uint MemoryAddressRef { private set; get; }
3737
/// <summary>
3838
/// ID of the subfile that stores the network tile

‎SC4Parser/SubFiles/PrebuiltNetworkSubfile.cs

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
1-
using SC4Parser.DataStructures;
2-
using SC4Parser.Logging;
3-
using System;
1+
using System;
42
using System.Collections.Generic;
53

4+
using SC4Parser.Logging;
5+
using SC4Parser.Structures;
6+
67
namespace SC4Parser
78
{
89
/// <summary>
910
/// Implementation of the Prebuilt Network Subfile. This file appears to contain all files with prefabricated models (e.g. elevated highways and monorail).
1011
/// </summary>
1112
/// <remarks>
1213
/// Actual implementation of tiles found in this file can be found in DataStructure\PrebuiltNetworkTile.cs
13-
///
14+
///
1415
/// Implemented and references additional data from https://wiki.sc4devotion.com/index.php?title=Network_Subfiles.
1516
/// </remarks>
16-
/// <seealso cref="SC4Parser.DataStructures.PrebuiltNetworkTile"/>
17+
/// <seealso cref="SC4Parser.Structures.PrebuiltNetworkTile"/>
1718
/// <seealso cref="SC4Parser.Subfiles.NetworkSubfile1"/>
1819
public class PrebuiltNetworkSubfile
19-
{ /// <summary>
20-
/// Contains all network tiles in the network subfile
21-
/// </summary>
22-
/// <see cref="SC4Parser.DataStructures.PrebuiltNetworkTile"/>
20+
{
21+
/// <summary>
22+
/// Contains all network tiles in the network subfile
23+
/// </summary>
24+
/// <see cref="SC4Parser.Structures.PrebuiltNetworkTile"/>
2325
public List<PrebuiltNetworkTile> NetworkTiles { get; private set; } = new List<PrebuiltNetworkTile>();
2426

2527
/// <summary>
@@ -40,7 +42,7 @@ public void Parse(byte[] buffer, int size)
4042
// Loop through each byte in the subfile
4143
while (bytesToRead > 0)
4244
{
43-
// Work out the current tile size
45+
// Work out the current tile size
4446
// (each tile is stored one after another in the file with the size of tile at the beginning)
4547
uint recordSize = BitConverter.ToUInt32(buffer, (int)offset);
4648

@@ -100,4 +102,4 @@ public void Dump()
100102
}
101103
}
102104
}
103-
}
105+
}

0 commit comments

Comments
 (0)