Class CifRciFile

Connects to a *.CIF or *.RCI file to enumerate and extract image data. Each CIF file may contain one or more images, including animated records with multiple frames. Each RCI file may contain one or more images, but never animated records.

Inheritance

Object

BaseImageFile

CifRciFile

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 CifRciFile : BaseImageFile

Constructors

CifRciFile()

Default constructor.

Declaration

public CifRciFile()

CifRciFile(String, FileUsage, DFPalette, Boolean)

Load constructor with palette assignment.

Declaration

public CifRciFile(string filePath, FileUsage usage, DFPalette palette, bool readOnly)

Parameters

Type	Name	Description
String	filePath	Absolute path to *.CIF or *.RCI file.
FileUsage	usage	Specify if file will be accessed from disk, or loaded into RAM.
DFPalette	palette	Palette to use when building images.
Boolean	readOnly	File will be read-only if true, read-write if false.

CifRciFile(String, FileUsage, Boolean)

Load constructor.

Declaration

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

Parameters

Type	Name	Description
String	filePath	Absolute path to *.CIF or *.RCI 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.

CifRciFile(String, FileUsage, String, Boolean)

Load constructor that also loads a palette.

Declaration

public CifRciFile(string filePath, FileUsage usage, string paletteFilePath, bool readOnly)

Parameters

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

Properties

Description

Description of this file.

Declaration

public override string Description { get; }

Property Value

Type	Description
String

Overrides

BaseImageFile.Description

PaletteName

Return correct palette name for this file (always ART_PAL.COL for CIF and RCI files).

Declaration

public override string PaletteName { get; }

Property Value

Type	Description
String

Overrides

BaseImageFile.PaletteName

RecordCount

Number of image records in this Cif or Rci 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 in specified record.

Declaration

public override int GetFrameCount(int record)

Parameters

Type	Name	Description
Int32	record	Index of record.

Returns

Type	Description
Int32	Number of frames.

Overrides

BaseImageFile.GetFrameCount(Int32)

GetOffset(Int32)

Gets X and Y offset of specified record (where appropriate).

Declaration

public DFPosition GetOffset(int record)

Parameters

Type	Name	Description
Int32	record	Index of record.

Returns

Type	Description
DFPosition	DFPosition object.

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 CIF or RCI file.

Declaration

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

Parameters

Type	Name	Description
String	filePath	Absolute path to *.CIF or *.RCI 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	True if successful, otherwise false.

Overrides

BaseImageFile.Load(String, FileUsage, Boolean)