View source for Wrp File Format - OPRWv17 to 24

[[Category:Sandbox]]

{{unsupported-doc}}

==Introduction==

===Legend===
*'''byte'''	8 bits,	unsigned.
*'''ushort'''	2 bytes, unsigned.
*'''ulong'''	4 bytes, unsigned.
*'''float'''	4 bytes, signed.
*'''asciiz'''   variable length zero terminated string

==File Format==
<code><nowiki>
structHeader Header;
structGridPack UnknownGrid1; //Packed with "Grid-Packing-Algorithm"
structGridPack UnknownGrid2; //Packed with "Grid-Packing-Algorithm"
structPeaks Peaks;
structTextureGridMaterials GridPackedMaterialIndices; //Packed with "Grid-Packing-Algorithm"
ushort PackedRandom[texZ][texX]; //probably random values needed for calculating clutter models position
byte PackedBytes1[gridZ][gridX]; // seems to be related to clutters or sat mask distance as it is responsible for the </nowiki>[http://tinyurl.com/6b27ed clutterbug]<nowiki>
float PackedElevation[gridZ][gridX];
structMaterials Materials;
structModels Models;
structClassedModels ClassedModels;
structGridPack UnknownGrid3; //Packed with "Grid-Packing-Algorithm"
ulong SizeOfObjects;         // div / 60 for nObjects
structGridPack UnknownGrid4; //Packed with "Grid-Packing-Algorithm"
ulong SizeOfSomething;       // probably the mapinfo
byte PackedBytes2[texZ][texX]; //seems to be connected to roads, runways and special grounds
byte PackedBytes3[gridZ][gridX]; //unknown but 0x00 for forests and roads and sea, mostly 0x03 and rarely 0x02
ulong maxObjectID; //not number of objects
ulong ObjectBlockOffset; //amount of bytes used for RoadNets
structRoadNet RoadNets[texZ,texX]; //probably organized in texture grid cells to realize terrain streaming
structObject Objects[unknown];
structMapInfo MapInfos[]; //have to be iterated until EndOfFile
</nowiki></code>

==Structures==

===structHeader===
<code><nowiki>
structHeader
{
	char signature[4];	//"OPWR"
	ulong version;		//0x12 = 18
	ulong texX,texZ;         //textures cell dimensions. 256x256 eg
	ulong gridX,gridZ;	//elevations cell dimensions. 256x256 eg
	float gridSize;		//in meters (normally 50.0)
}
</nowiki></code>
----


----
===structPeaks===
<code><nowiki>
structPeaks
{
	ulong nPeaks;
	float XZY[nPeaks][3]; //Position of the Peak  (Z is height)
}
</nowiki></code>
----


----
===structTextureGridMaterials===
<code><nowiki>
structTextureGridMaterials
{
	//still need to be worked out
}
</nowiki></code>
----


----
===structMaterials===

<code><nowiki>
structMaterials
{
	ulong nMaterials; //Number of Rvmat entries (at least one)
	structMaterial Materials[nMaterials];
}
</nowiki></code>
At least one material is always present at the first position of ''Materials'' with an empty path, so ''nMaterials'' appears to be one more than the real count of materials.

====structMaterial====
<code><nowiki>
structMaterial
{
	asciiz rvmat_path;
	byte 0x00;
}
</nowiki></code>
----


----

===structModels===
<code><nowiki>
structModels
{
	ulong nModels;		        //number of models
	asciiz modelPaths[nModels];	//e.g. ca\buildings\kostelik.p3d
}
</nowiki></code>

This is a simple list of models that are used on the island. These are referenced in [[#structObject|structObject]] by their index in the ''modelPaths'' array with the first index being 0.

----


----

===structClassedModels===
<code><nowiki>
structClassedModels
{
	ulong nClassedModels;	//number of classed models
	structClassedModel Models[nClassedModels];
}
</nowiki></code>

====structClassedModel====
<code><nowiki>
structClassedModel
{
	asciiz class_name;	//e.g. Land_Hangar
	asciiz model_path;       //e.g. ca\buildings\kostelik.p3d
	float pos[3];            //XZY
	ulong unknown;
}
</nowiki></code>
----


----
===structRoadNet===
<code><nowiki>
structRoadNet
{
	ulong nRoadParts; // Zero or More... 
	structRoadPart RoadParts[nRoadParts];
}
</nowiki></code>
Because of the variable length of the asciiz strings in '''structRoadPart''', the actual position of the following [[#structObjects|structObjects]] block cannot be pre-calculated. Therefore the ''ObjectBlockOffset'' can be used, as it is the size (in bytes) of this '''structRoadNet''' block.

Each grid cell of an island contains a '''structRoadNet''' entry. If there are no road(s) in that cell, there are no '''structRoadParts'''. Consequently, a 256 x 256 cell island with '''no''' roads would have a '''structRoadNet''' block consisting of 256 x 256 x 4 zeros. So if ''ObjectBlockOffset'' == texZ * texX * 4, you can skip this block, because you know it does not contain any roads.

It is probably saved this way to better realize terrain streaming.

====structRoadPart====
<code><nowiki>
structRoadPart
{
	ushort nRoadPositions;
	float RoadPositions[nRoadPositions][3]; //XYZ
	byte Flags[4];
	asciiz Model;
	float matrix[12];
}
</nowiki></code>
----


----

===structObject===
<code><nowiki>
structObject
{
	ulong ObjectID;
	ulong modelIndex;
	float matrix[12];
	ulong 0x02;
}
</nowiki></code>

''modelIndex'' refers to the list of modelpaths in [[#structModels|structModels]].

''ObjectID'' is used to uniquely identify every object. Therefore you won't find two objects having the same ''ObjectID''.
----


----

===structMapInfo===
<code><nowiki>
structMapInfo
{
	ulong infoType;
	
	if(infoType in [0,1,2,10,11,13,14,15,16,17,22,23,26,27,30]) structType1 type1;
	if(infoType in [24,31,32]) structType2 type2;
	if(infoType in [25,33]) structType3 type3;
	if(infoType in [3,4,8,9,18,19,20,28,29]) structType4 type4;
	if(infoType in [34]) structType5 type5;
}
</nowiki></code>

====structType1====
<code><nowiki>
structType1
{
	ulong ObjectId
	float x, z
}
</nowiki></code>

====structType2====
<code><nowiki>
structType2
{
	ulong ObjectId
	float[4][2] Bounds
}
</nowiki></code>

====structType3====
<code><nowiki>
structType3
{
	long[2] unknown
	float[2][2] line?
}
</nowiki></code>

====structType4====
<code><nowiki>
structType4
{
	ulong ObjectId
	float[4][2] Bounds
	byte[4] Color //rgba
}
</nowiki></code>

====structType5====
<code><nowiki>
structType5
{
	ulong ObjectId
	float[2][2] line?
}
</nowiki></code>


==Packed Data==
All variables starting with "Packed" are compressed with the common BIS algorithm that is also used in [[PAA File Format|paa]] and OFP [[PBO File Format|pbo]] files.