Class ExcelModule

Inheritance
System.Object
ExcelModule
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lumina.Excel
Assembly: Lumina.dll
Syntax
public class ExcelModule

Constructors

| Improve this Doc View Source

ExcelModule(Lumina)

Declaration
public ExcelModule(Lumina lumina)
Parameters
Type Name Description
Lumina lumina

Fields

| Improve this Doc View Source

ImmutableIdToSheetMap

Mapping between internal IDs used to index sheets loaded at startup to their name.

Declaration
public readonly Dictionary<int, string> ImmutableIdToSheetMap
Field Value
Type Description
System.Collections.Generic.Dictionary<System.Int32, System.String>
Remarks

Not actually used for anything in lumina, but kept for reference

| Improve this Doc View Source

SheetNames

A list of all available sheets, pulled from root.exl

Declaration
public readonly List<string> SheetNames
Field Value
Type Description
System.Collections.Generic.List<System.String>

Methods

| Improve this Doc View Source

BuildExcelHeaderPath(String)

Generates a path to the header file, given a sheet name.

Declaration
public string BuildExcelHeaderPath(string name)
Parameters
Type Name Description
System.String name

A sheet name
Returns
Type Description
System.String

An absolute path to an excel header file
Remarks

Sheet names must be in the same format as they're in root.exl. You can see all available sheets by iterating SheetNames.

| Improve this Doc View Source

GetSheet<T>()

Attempts to load the base excel sheet given it's implementing row parser

Declaration
public ExcelSheet<T> GetSheet<T>()
    where T : class, IExcelRow
Returns
Type Description
ExcelSheet<T>

An ExcelSheet<T> if the sheet exists, null if it does not
Type Parameters
Name Description
T

A class that implements IExcelRow to parse rows
| Improve this Doc View Source

GetSheet<T>(Language)

Attempts to load the base excel sheet with a specific language

Declaration
public ExcelSheet<T> GetSheet<T>(Language language)
    where T : class, IExcelRow
Parameters
Type Name Description
Language language

The requested sheet language
Returns
Type Description
ExcelSheet<T>

An ExcelSheet<T> if the sheet exists, null if it does not
Type Parameters
Name Description
T

A class that implements IExcelRow to parse rows
Remarks

If the language requested doesn't exist for the file, this will silently be ignored and it will return a sheet with the default language: None

| Improve this Doc View Source

GetSheet<T>(String)

Get a sheet by it's name with a given type.

Useful for when a schema is shared (e.g. in the case of quest text sheets) as redefining loads of classes is wasteful.

Declaration
public ExcelSheet<T> GetSheet<T>(string name)
    where T : class, IExcelRow
Parameters
Type Name Description
System.String name

The name of a sheet
Returns
Type Description
ExcelSheet<T>

An ExcelSheet<T> if the sheet exists, null if it does not
Type Parameters
Name Description
T

A class that implements IExcelRow to parse rows
| Improve this Doc View Source

GetSheetRaw(String, Language)

Returns a raw accessor to an excel sheet allowing you to skip templated row access entirely.

Declaration
public ExcelSheetImpl GetSheetRaw(string name, Language language = Language.None)
Parameters
Type Name Description
System.String name

Name of the sheet to load
Language language

The requested language to load
Returns
Type Description
ExcelSheetImpl

A ExcelSheetImpl object, or null if the sheet name was not found.