Twilight Princess
Remastered version of the GameCube game
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | Private Member Functions | List of all members
KclLibrary.AttributeHandlers.BCSV Class Reference

Repesents a binary variant of csv used for the J3D engine. More...

Classes

class  Field
 A field of the BCSV. More...
 
class  Record
 A record of the BCSV. More...
 

Public Types

enum  FieldType {
  Int32 = 0 , String = 1 , Float = 2 , Int16 = 4 ,
  Byte = 5 , StringJIS = 6
}
 The field data type. More...
 

Public Member Functions

 BCSV ()
 Constructs a new empty BCSV binary.
 
 BCSV (Stream stream)
 Reads a BCSV from the given the stream.
 
void Save (string filePath)
 Saves a BCSV to the given file path.
 
void Save (Stream stream)
 Saves a BCSV to the given stream.
 

Public Attributes

bool IsBigEndian = false
 Wether or not the binary byte order is big endian or not.
 
List< Field > Fields = new List<Field>()
 A list of fields used.
 
List< Record > Records = new List<Record>()
 A list of records used from the fields.
 

Private Member Functions

void Read (BinaryDataReader reader)
 
void Write (BinaryDataWriter writer)
 
uint MaxFieldSize ()
 
uint AlignedSize (uint size, uint amount)
 
void AlignBytes (BinaryDataWriter writer, int alignment, byte value=0x00)
 

Detailed Description

Repesents a binary variant of csv used for the J3D engine.

Member Enumeration Documentation

◆ FieldType

enum KclLibrary.AttributeHandlers.BCSV.FieldType

The field data type.

Enumerator
Int32 

The field data is an int.

String 
Float 
Int16 
Byte 
StringJIS 

The field data is a string encoded in shift JIS.

Constructor & Destructor Documentation

◆ BCSV() [1/2]

KclLibrary.AttributeHandlers.BCSV.BCSV ( )

Constructs a new empty BCSV binary.

◆ BCSV() [2/2]

KclLibrary.AttributeHandlers.BCSV.BCSV ( Stream stream)

Reads a BCSV from the given the stream.

Parameters
stream

Member Function Documentation

◆ AlignBytes()

void KclLibrary.AttributeHandlers.BCSV.AlignBytes ( BinaryDataWriter writer,
int alignment,
byte value = 0x00 )
private

◆ AlignedSize()

uint KclLibrary.AttributeHandlers.BCSV.AlignedSize ( uint size,
uint amount )
private

◆ MaxFieldSize()

uint KclLibrary.AttributeHandlers.BCSV.MaxFieldSize ( )
private

◆ Read()

void KclLibrary.AttributeHandlers.BCSV.Read ( BinaryDataReader reader)
private

◆ Save() [1/2]

void KclLibrary.AttributeHandlers.BCSV.Save ( Stream stream)

Saves a BCSV to the given stream.

Parameters
stream

◆ Save() [2/2]

void KclLibrary.AttributeHandlers.BCSV.Save ( string filePath)

Saves a BCSV to the given file path.

Parameters
filePath

◆ Write()

void KclLibrary.AttributeHandlers.BCSV.Write ( BinaryDataWriter writer)
private

Member Data Documentation

◆ Fields

List<Field> KclLibrary.AttributeHandlers.BCSV.Fields = new List<Field>()

A list of fields used.

◆ IsBigEndian

bool KclLibrary.AttributeHandlers.BCSV.IsBigEndian = false

Wether or not the binary byte order is big endian or not.

◆ Records

List<Record> KclLibrary.AttributeHandlers.BCSV.Records = new List<Record>()

A list of records used from the fields.

The documentation for this class was generated from the following file: