Class WadFile

Represents a WAD archive

Inheritance
System.Object
WadFile
Namespace: LeagueToolkit.Core.Wad
Assembly: LeagueToolkit.dll
Syntax
public sealed class WadFile : IDisposable
Remarks

Use WadBuilder to build WAD files

Constructors

| Improve this Doc View Source

WadFile(FileStream)

Creates a new WadFile object using the specified parameters

Declaration
public WadFile(FileStream stream)
Parameters
Type Name Description
FileStream stream

The stream to read the WadFile from
| Improve this Doc View Source

WadFile(String)

Creates a new WadFile object using the specified parameters

Declaration
public WadFile(string path)
Parameters
Type Name Description
System.String path

The path of the WadFile

Properties

| Improve this Doc View Source

Chunks

Gets the chunks

Declaration
public IReadOnlyDictionary<ulong, WadChunk> Chunks { get; }
Property Value
Type Description
IReadOnlyDictionary<System.UInt64, WadChunk>
| Improve this Doc View Source

IsDisposed

Gets a value indicating whether the archive has been disposed of

Declaration
public bool IsDisposed { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Subchunks

Declaration
public ReadOnlyMemory<WadSubchunk> Subchunks { get; }
Property Value
Type Description
ReadOnlyMemory<WadSubchunk>

Methods

| Improve this Doc View Source

Dispose()

Disposes the WadFile object and the wrapped instance

Declaration
public void Dispose()
| Improve this Doc View Source

FindChunk(String)

Searches for a chunk with the specified path

Declaration
public WadChunk FindChunk(string path)
Parameters
Type Name Description
System.String path

The path of the WadChunk
Returns
Type Description
WadChunk

The found chunk
| Improve this Doc View Source

FindChunk(UInt64)

Searches for a chunk with the specified path hash

Declaration
public WadChunk FindChunk(ulong pathHash)
Parameters
Type Name Description
System.UInt64 pathHash

The lowercase path of the WadChunk hashed using

Returns
Type Description
WadChunk

The found chunk
| Improve this Doc View Source

LoadChunk(WadChunk)

Loads the raw data of the specified chunk into memory

Declaration
public MemoryOwner<byte> LoadChunk(WadChunk chunk)
Parameters
Type Name Description
WadChunk chunk

The chunk to load
Returns
Type Description
MemoryOwner<System.Byte>

A object with the loaded chunk data
| Improve this Doc View Source

LoadChunk(String)

Loads the raw data of the specified chunk into memory

Declaration
public MemoryOwner<byte> LoadChunk(string path)
Parameters
Type Name Description
System.String path

The path of the chunk to load
Returns
Type Description
MemoryOwner<System.Byte>

A object with the loaded chunk data
| Improve this Doc View Source

LoadChunk(UInt64)

Loads the raw data of the specified chunk into memory

Declaration
public MemoryOwner<byte> LoadChunk(ulong pathHash)
Parameters
Type Name Description
System.UInt64 pathHash

The path hash of the chunk to load
Returns
Type Description
MemoryOwner<System.Byte>

A object with the loaded chunk data
| Improve this Doc View Source

LoadChunkDecompressed(WadChunk)

Loads the decompressed data of the specified chunk into memory

Declaration
public MemoryOwner<byte> LoadChunkDecompressed(WadChunk chunk)
Parameters
Type Name Description
WadChunk chunk

The chunk to load
Returns
Type Description
MemoryOwner<System.Byte>

A object with the loaded decompresed chunk data
| Improve this Doc View Source

LoadChunkDecompressed(String)

Loads the decompressed data of the specified chunk into memory

Declaration
public MemoryOwner<byte> LoadChunkDecompressed(string path)
Parameters
Type Name Description
System.String path

The path of the chunk to load
Returns
Type Description
MemoryOwner<System.Byte>

A object with the loaded decompresed chunk data
| Improve this Doc View Source

LoadChunkDecompressed(UInt64)

Loads the decompressed data of the specified chunk into memory

Declaration
public MemoryOwner<byte> LoadChunkDecompressed(ulong pathHash)
Parameters
Type Name Description
System.UInt64 pathHash

The path hash of the chunk to load
Returns
Type Description
MemoryOwner<System.Byte>

A object with the loaded decompresed chunk data
| Improve this Doc View Source

OpenChunk(WadChunk)

Opens a decompression stream for the specified chunk

Declaration
public Stream OpenChunk(WadChunk chunk)
Parameters
Type Name Description
WadChunk chunk

The chunk to open a stream for
Returns
Type Description
Stream

A object that can be used to decompress the data using

| Improve this Doc View Source

OpenChunk(String)

Opens a decompression stream for the specified chunk

Declaration
public Stream OpenChunk(string path)
Parameters
Type Name Description
System.String path

The path of the chunk to open a stream for
Returns
Type Description
Stream

A object that can be used to decompress the data using

| Improve this Doc View Source

OpenChunk(UInt64)

Opens a decompression stream for the specified chunk

Declaration
public Stream OpenChunk(ulong pathHash)
Parameters
Type Name Description
System.UInt64 pathHash

The path hash of the chunk to open a stream for
Returns
Type Description
Stream

A object that can be used to decompress the data using