Class CfaFile

Connects to *.CFA files to extract image data. CFA is a legacy Arena image file format that is largely unused in Daggerfall. Most significant usage is first-person horse and cart transport modes. Notes: This implementation is limited in that it only supports 8-bit wide indexed pixels without muxing. Thanks to creator of WinArena for releasing source to decode Arena CFA files. This made it significantly easier to research Daggerfall's CFA files for DFTFU.

Inheritance

Object

BaseImageFile

CfaFile

Inherited Members

BaseImageFile.myPalette

BaseImageFile.FilePath

BaseImageFile.FileName

BaseImageFile.Palette

BaseImageFile.LoadPalette(String)

BaseImageFile.GetColor32(Int32, Int32, Int32)

BaseImageFile.GetColor32(DFBitmap, Int32)

BaseImageFile.GetColor32(Int32, Int32, Int32, Int32, DFSize)

BaseImageFile.GetColor32(DFBitmap, Int32, Int32, DFSize, Int32, Int32)

BaseImageFile.GetWindowColors32(DFBitmap, Int32)

BaseImageFile.GetSpectralEmissionColors32(DFBitmap, Color32[], Int32, Int32, Color, Color)

BaseImageFile.GetFireWallColors32(Color32[], Int32, Int32, Color, Single)

Namespace: DaggerfallConnect.Arena2

Assembly: Assembly-CSharp.dll

Syntax

public class CfaFile : BaseImageFile

Constructors

CfaFile()

Default constructor.

Declaration

public CfaFile()

CfaFile(String, FileUsage, Boolean)

Load constructor.

Declaration

public CfaFile(string filePath, FileUsage usage, bool readOnly)

Parameters

Type	Name	Description
String	filePath	Absolute path to *.CFA file.
FileUsage	usage	Specify if file will be accessed from disk, or loaded into RAM.
Boolean	readOnly	File will be read-only if true, read-write if false.

Properties

Description

Description of this file (always "CFA File" as game data contain no text descriptions for this file type).

Declaration

public override string Description { get; }

Property Value

Type	Description
String

Overrides

BaseImageFile.Description

PaletteName

Gets palette name for CFA file.

Declaration

public override string PaletteName { get; }

Property Value

Type	Description
String

Overrides

BaseImageFile.PaletteName

RecordCount

Number of image records in this CFA file.

Declaration

public override int RecordCount { get; }

Property Value

Type	Description
Int32

Overrides

BaseImageFile.RecordCount

Methods

GetDFBitmap(Int32, Int32)

Gets bitmap data as indexed 8-bit byte array for specified record and frame.

Declaration

public override DFBitmap GetDFBitmap(int record, int frame)

Parameters

Type	Name	Description
Int32	record	Index of record.
Int32	frame	Index of frame.

Returns

Type	Description
DFBitmap	DFBitmap object.

Overrides

BaseImageFile.GetDFBitmap(Int32, Int32)

GetFrameCount(Int32)

Gets number of frames.

Declaration

public override int GetFrameCount(int record)

Parameters

Type	Name	Description
Int32	record	Record index. Only 1 record in Daggerfall CFA files so value should be 0.

Returns

Type	Description
Int32	Number of frames.

Overrides

BaseImageFile.GetFrameCount(Int32)

GetSize(Int32)

Gets width and height of specified record. All frames of this record are the same dimensions.

Declaration

public override DFSize GetSize(int record)

Parameters

Type	Name	Description
Int32	record	Index of record.

Returns

Type	Description
DFSize	DFSize object.

Overrides

BaseImageFile.GetSize(Int32)

Load(String, FileUsage, Boolean)

Loads a CFA file.

Declaration

public override bool Load(string filePath, FileUsage usage, bool readOnly)

Parameters

Type	Name	Description
String	filePath	Absolute path to *.CFA file.
FileUsage	usage	Specify if file will be accessed from disk, or loaded into RAM.
Boolean	readOnly	File will be read-only if true, read-write if false.

Returns

Type	Description
Boolean

Overrides

BaseImageFile.Load(String, FileUsage, Boolean)