Show / Hide Table of Contents

Class FlatsFile

Connects to FLATS.CFG and reads flats data.

Inheritance
Object
FlatsFile
Namespace: DaggerfallConnect.Arena2
Assembly: Assembly-CSharp.dll
Syntax
public class FlatsFile

Constructors

| Improve this Doc View Source

FlatsFile()

Declaration
public FlatsFile()
| Improve this Doc View Source

FlatsFile(String, FileUsage, Boolean)

Declaration
public FlatsFile(string filePath, FileUsage usage, bool readOnly)
Parameters
Type Name Description
String filePath
FileUsage usage
Boolean readOnly

Properties

| Improve this Doc View Source

Filename

Gets default FLATS.CFG filename.

Declaration
public static string Filename { get; }
Property Value
Type Description
String
| Improve this Doc View Source

FlatsDict

Declaration
public Dictionary<int, FlatsFile.FlatData> FlatsDict { get; }
Property Value
Type Description
Dictionary<Int32, FlatsFile.FlatData>

Methods

| Improve this Doc View Source

GetFlatData(Int32)

Turns a flat int back into archive/record format

Declaration
public FlatsFile.FlatData GetFlatData(int flat)
Parameters
Type Name Description
Int32 flat
Returns
Type Description
FlatsFile.FlatData
| Improve this Doc View Source

GetFlatData(Int32, out FlatsFile.FlatData)

Gets flat data from flats ID.

Declaration
public bool GetFlatData(int flatID, out FlatsFile.FlatData flatDataOut)
Parameters
Type Name Description
Int32 flatID

Flat ID.

FlatsFile.FlatData flatDataOut

Receives flats data.

Returns
Type Description
Boolean

True if successful.

| Improve this Doc View Source

GetFlatID(Int32, Int32)

Gets flat ID from billboards archive and record index.

Declaration
public static int GetFlatID(int archiveIndex, int recordIndex)
Parameters
Type Name Description
Int32 archiveIndex

texture archive index of billboard.

Int32 recordIndex

texture record index inside texture archive of billboard.

Returns
Type Description
Int32

Flats ID if found, otherwise -1.

| Improve this Doc View Source

Load(String, FileUsage, Boolean)

Load from FLATS.CFG file.

Declaration
public void Load(string filePath, FileUsage usage, bool readOnly)
Parameters
Type Name Description
String filePath

Absolute path to FLATS.CFG 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.

| Improve this Doc View Source

ReverseFlatID(Int32, out Int32, out Int32)

Declaration
public static void ReverseFlatID(int flatID, out int archiveIndex, out int recordIndex)
Parameters
Type Name Description
Int32 flatID
Int32 archiveIndex
Int32 recordIndex
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX