Class ItemsFile

Reads item template data from FALL.EXE and structures for use. There is no "items file" as such for this data, just keeping naming conveniention similar to other API classes.

Inheritance

Object

ItemsFile

Namespace: DaggerfallConnect.FallExe

Assembly: Assembly-CSharp.dll

Syntax

public class ItemsFile

Constructors

| Improve this Doc View Source

ItemsFile()

Default constructor.

Declaration

public ItemsFile()

| Improve this Doc View Source

ItemsFile(String)

Path constructor.

Declaration

public ItemsFile(string fallExePath)

Parameters

Type	Name	Description
String	fallExePath	Path to FALL.EXE.

Properties

| Improve this Doc View Source

Filename

Gets static FALL.EXE filename.

Declaration

public static string Filename { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

FilePath

Gets path to FALL.EXE file.

Declaration

public string FilePath { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

IsOpen

Gets file open flag.

Declaration

public bool IsOpen { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

ItemsArray

Gets array of native item data.

Declaration

public DFItem[] ItemsArray { get; }

Property Value

Type	Description
DFItem[]

| Improve this Doc View Source

ItemsCount

Gets number of items enumerated.

Declaration

public int ItemsCount { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

ItemsOffset

Gets or sets the items offset.

Declaration

public int ItemsOffset { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

LastException

Gets last exception.

Declaration

public Exception LastException { get; }

Property Value

Type	Description
Exception

Methods

| Improve this Doc View Source

GetItem(Int32)

Gets native item data as read from FALL.EXE.

Declaration

public DFItem GetItem(int index)

Parameters

Type	Name	Description
Int32	index	index of item.

Returns

Type	Description
DFItem	DFItem

| Improve this Doc View Source

GetItemDescription(Int32)

Gets a item description pre-formatted into friendly data.

Declaration

public ItemTemplate GetItemDescription(int index)

Parameters

Type	Name	Description
Int32	index	Index of item.

Returns

Type	Description
ItemTemplate	ItemTemplate

| Improve this Doc View Source

OpenFallExeFile(String, FileUsage, Boolean)

Opens FALL.EXE file.

Declaration

public bool OpenFallExeFile(string fallExePath, FileUsage fileUsage = FileUsage.UseMemory, bool readOnly = true)

Parameters

Type	Name	Description
String	fallExePath	Path to FALL.EXE file.
FileUsage	fileUsage	How to load file
Boolean	readOnly	Open file read-only

Returns

Type	Description
Boolean	True if successful.

| Improve this Doc View Source

RewriteItem(DFItem)

Rewrites item data back into disk file. Must have been opened with FileUsage.UseDisk and readOnly flag false.

Declaration

public void RewriteItem(DFItem item)

Parameters

Type	Name	Description
DFItem	item	Item to rewrite.