Show / Hide Table of Contents

Class FileHandleManager

Inheritance
System.Object
FileHandleManager
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.Data
Assembly: Lumina.dll
Syntax
public class FileHandleManager

Properties

| Improve this Doc View Source

HasPendingFileLoads

Whether the file queue contains any files that are yet to be loaded

Declaration
public bool HasPendingFileLoads { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

CreateHandle<T>(String)

Creates a new handle to a game file but does not load it. You will need to call ProcessQueue() or the wrapper function ProcessFileHandleQueue() yourself for these handles to be loaded, on a different thread.

Declaration
public FileHandle<T> CreateHandle<T>(string path)
    where T : FileResource
Parameters
Type Name Description
System.String path

The path to the file to load

Returns
Type Description
FileHandle<T>

A handle to the file to be loaded

Type Parameters
Name Description
T

The type of FileResource to load

| Improve this Doc View Source

ProcessQueue()

Processes enqueued file handles that haven't been loaded yet. You should call this on a different thread to process handles.

Declaration
public void ProcessQueue()
  • Improve this Doc
  • View Source
Back to top Generated by DocFX