Wrp File Format - 4WVR: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{unsupported-doc}}" to "{{Feature|UnsupportedDoc}}")
 
(22 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{unsupported-doc}}
{{Feature|UnsupportedDoc}}
==General==
== General ==
''Flashpoint wrp files use two different file formats to contain the data. This document contains information on 4WVR format as used by WrpTool (http://flashpoint.nekromantix.com), and with BIStudio's tool "O2light".  
''Flashpoint wrp files use two different file formats to contain the data. This document contains information on unbinarised 4WVR format as used by [[OFP: Community Tools | WrpTool]] and [[Visitor 2]].  


This document does '''not''' discuss the alternate format, [[Wrp File Format - OPRW|OPRW]]. Both file formats can be used directly by the engine, whether the file exists independently in ~\worlds, or, packed inside a pbo (addon). ''
This document does '''not''' discuss the '''binary''' format, [[Wrp File Format - OPRW|OPRW]]. Both file formats can be used directly by the engine, whether the file exists independently in ~\worlds, or, packed inside a pbo (addon). ''


See [[Wrp File Format|General Wrp format]] for further info.
See [[BIS_File_Formats#Island_File_Formats|Island File Formats]] for further info.


"Binarize" tool by BIStudio will convert 4WVR to OPRW if desired.
"Binarize" tool by BIStudio will convert 4WVR to OPRW if desired.
Line 11: Line 11:
(some problems exist with 2 versions of binarize)
(some problems exist with 2 versions of binarize)


===Conventions===
For a general description of how simple this (or any other) wrp file construct, see [[Wrp_File_Format_-_8WVR|8WVR format]]
Intel byte order, lsb first
byte = 1 char = 8 bits
ulong = unsigned long, 4 bytes
ushort= unsigned short 2 bytes
asciiz= variable length zero terminated string.
float= 4byte (single precision)


==Structure==
=== Conventions ===
see [[Generic FileFormat Data Types]]


  struct
== Structure ==
 
  4WVR
  {
  {
  byte Signature[4]; //"4WVR"
  WRP4Header          Header
  ulong Xsize;      //(=256) cell dimension
  CompressedFloats    Elevations [Ysize][Xsize]; // in centimetres. See below
  ulong Ysize;      //(=256) cell dimension
  ushort              TextureIndex[Ysize][Xsize]; //Each 'index' refers to a filename below. Range 1..511
  short Elevations[Ysize][Xsize]; // eg 2*256*256 = 131072 bytes See Note
  char                TextureFilenames[512][32];  //"data\pi.paa\0|data\pi1.paa\0".....
  short TextureIndex[Ysize][Xsize]; // eg 2*256*256 = 131072 bytes
   Model              Models[...];
      //Each 'index' refers to a filename below. Max value = 511
  }
  Asciiz TextureFilenames[512][32];
=== WRP4Header ===
  /*
  WRP4Header
A max of 512 texture files can be listed. Each is held as an asciiz string inside a fixed 32 byte
record. Eg max length of filename is 31 characters.
   example: data\pi.paa
  */
 
  struct model
  {
  {
  float TransformMatrix[12]; //see below
  char Signature[4]; //"4WVR"
  long  3DobjectIndex;      //the unique ouid for this model
ulong Xsize;      //(=256) cell dimension
  asciiz Filename[76];
ulong Ysize;       //(=256) cell dimension
  //each string is held within a 76 byte record. Therefore filename is 75 chars max.
  }
  }[variable];


//...see below
==== Elevations ====
};
Elevations are expressed as an integral of the gridsize.


Since the gridsize for {{ofp}} is a fixed 50 meters, to convert the value into meters:


==Note1==
RealHeight = Elevations[x][y] * 0.05;


TransformMatrix[4][3];
Note that (probably WrpTool) can set a default index of -1 (0xFFFF). The meaning is unclear.


This is the transform matrix used directly by Micro$oft DirectX engines.
see Talk


In fact, the 'correct' matrix is actually 4 x 4, but the last column always represents 0,0,0,1 thus
==== TextureIndex ====
M11,M12 M13 (0.0)
Each cell on the map references an texture file (pac/paa) and an elevation for that text at that cell position.
M21,M22,M23 (0.0)
Since there could be myriads of 'sea' texture (eg), rather than have each cell list it is texture, it references a texture list via an index. In this way, THE texture which is common to many cells (at sometimes differing elevations) is only stored once.
M31,M32,M33 (0.0)
M41,M42,M43 (1.0)


and so is never stored. This identical matrix is used for WRP files (both formats) and RTM files.
A fixed (and therefore max) table size of 512 texture filenames can be listed. Each is held as an asciiz string inside a fixed 32 byte record. Eg max length of filename is 31 characters. Each 32 byte record can contain garbage after the Asciiz. The first null entry is considered the end of the usable list.
The last row (M41...) happens to be the position of the object X Z Y co-ordinates, and is often referred to separately.


For further information visit [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/directx9_c/directx/graphics/programmingguide/fixedfunction/transforms/transforms.asp here]
The first entry (effectively index0) is never used. Even though a filename is associated with this entry. it is never accessed.


See [[Rtm (Animation) File Format|Wrp file format. General]]
=== Model ===
Model
{
  float  TransformMatrix[4][3]; // see [[Generic FileFormat Data Types]]
  long  ObjectID;              // unique for every entry
  asciiz P3DFilename[76];      // "data3d\kasna.p3d"
}


The number of models varies from none, to end of file. Each model is 128 bytes in length.


==Note2==
Note that this is in marked contrast to an 8WVR file. In 8WVR, there is always a minimum of one entry. The last (or only) entry in an 8WVR has no filename associated with it.
The number of models varies from none, to end of file. Each model is 128 bytes in length.
 
== FilePaths ==
 
Despite the impression given (lack of a leading \) All filenames (pac/paa and p3d files) are HARD WIRED to the (virtual) pboRoot\ directory.


The PboRoot\ directory is built in-situ during game load and consists of an index table of all addons from 'anywhere' in the game structure. Eg, the official Addon Directories (plural), the bin\folder, plus any oem addons stated in the command line.


[[category:Operation Flashpoint: Modelling]]
{{GameCategory|ofp|Modelling}}
[[Category:BIS_File_Formats]]

Latest revision as of 14:54, 1 February 2021

bi symbol white.png
Disclaimer: This page describes internal undocumented structures of Bohemia Interactive software.

This page contains unofficial information.

Some usage of this information may constitute a violation of the rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.
Bohemia Interactive is not willing to tolerate use of such tools if it contravenes any general licenses granted to end users of this community wiki or BI products.

General

Flashpoint wrp files use two different file formats to contain the data. This document contains information on unbinarised 4WVR format as used by WrpTool and Visitor 2.

This document does not discuss the binary format, OPRW. Both file formats can be used directly by the engine, whether the file exists independently in ~\worlds, or, packed inside a pbo (addon).

See Island File Formats for further info.

"Binarize" tool by BIStudio will convert 4WVR to OPRW if desired.

(some problems exist with 2 versions of binarize)

For a general description of how simple this (or any other) wrp file construct, see 8WVR format

Conventions

see Generic FileFormat Data Types

Structure

4WVR
{
  WRP4Header          Header
  CompressedFloats    Elevations  [Ysize][Xsize]; // in centimetres. See below 
  ushort              TextureIndex[Ysize][Xsize]; //Each 'index' refers to a filename below. Range 1..511
  char                TextureFilenames[512][32];  //"data\pi.paa\0|data\pi1.paa\0".....
  Model               Models[...];
}

WRP4Header

WRP4Header
{
char Signature[4]; //"4WVR"
ulong Xsize;       //(=256) cell dimension
ulong Ysize;       //(=256) cell dimension
}

Elevations

Elevations are expressed as an integral of the gridsize.

Since the gridsize for Operation Flashpoint is a fixed 50 meters, to convert the value into meters:

RealHeight = Elevations[x][y] * 0.05;

Note that (probably WrpTool) can set a default index of -1 (0xFFFF). The meaning is unclear.

see Talk

TextureIndex

Each cell on the map references an texture file (pac/paa) and an elevation for that text at that cell position. Since there could be myriads of 'sea' texture (eg), rather than have each cell list it is texture, it references a texture list via an index. In this way, THE texture which is common to many cells (at sometimes differing elevations) is only stored once.

A fixed (and therefore max) table size of 512 texture filenames can be listed. Each is held as an asciiz string inside a fixed 32 byte record. Eg max length of filename is 31 characters. Each 32 byte record can contain garbage after the Asciiz. The first null entry is considered the end of the usable list.

The first entry (effectively index0) is never used. Even though a filename is associated with this entry. it is never accessed.

Model

Model
{
 float  TransformMatrix[4][3]; // see Generic FileFormat Data Types
 long   ObjectID;              // unique for every entry
 asciiz P3DFilename[76];       // "data3d\kasna.p3d"
}

The number of models varies from none, to end of file. Each model is 128 bytes in length.

Note that this is in marked contrast to an 8WVR file. In 8WVR, there is always a minimum of one entry. The last (or only) entry in an 8WVR has no filename associated with it.

FilePaths

Despite the impression given (lack of a leading \) All filenames (pac/paa and p3d files) are HARD WIRED to the (virtual) pboRoot\ directory.

The PboRoot\ directory is built in-situ during game load and consists of an index table of all addons from 'anywhere' in the game structure. Eg, the official Addon Directories (plural), the bin\folder, plus any oem addons stated in the command line.