UAssetAPI Documentation

UAssetAPI is a .NET library for reading and writing Unreal Engine 4 game assets.

Features

• Low-level read/write capability for a wide variety of cooked .uasset files from ~4.13 to 4.27
• Support for more than 80 property types and 10 export types
• Support for JSON export and import to a proprietary format that maintains binary equality
• Support for reading and writing raw Kismet (blueprint) bytecode
• Reading capability for the unofficial .usmap format to parse ambiguous and unversioned properties
• Robust fail-safes for many properties and exports that fail serialization
• Automatic reflection for new property types in other loaded assemblies

Usage

To get started using UAssetAPI, first build the API using the Build Instructions guide and learn how to perform basic operations on your cooked .uasset files using the Basic Usage guide.

UAssetGUI, a graphical wrapper around UAssetAPI which allows you to directly view and modify game assets by hand, is also available and can be downloaded for free on GitHub at https://github.com/atenfyr/UAssetGUI/releases.

Support

The source code of UAssetAPI is publicly available on GitHub at https://github.com/atenfyr/UAssetAPI, and all contributions are greatly appreciated.

Any bugs or feature requests that you may have can be submitted on the GitHub page as an issue. I am also active on the Unreal Engine Modding Discord server and will often answer questions about UAssetAPI usage and functionality, which you can join with this invite link: https://discord.gg/zVvsE9mEEa.

Build Instructions

Prerequisites

• Visual Studio 2017 or later
• Git

Initial Setup

1. Clone the UAssetAPI repository:

git clone https://github.com/atenfyr/UAssetAPI.git

2. Open the UAssetAPI.sln solution file within the newly-created UAssetAPI directory in Visual Studio, right-click on the solution name in the Solution Explorer, and press "Restore Nuget Packages."

3. Press F6 or right-click the solution name in the Solution Explorer and press "Build Solution" to compile UAssetAPI, which will be written as a .dll file to the bin directory. Note that this solution does not include UAssetGUI.

Basic Usage

Prerequisites

• Basic C# knowledge
• Visual Studio 2017 or later
• A copy of UAssetAPI

Basic Project Setup

In this short guide, we will go over the very basics of parsing assets through UAssetAPI.

UAssetAPI targets .NET Standard 2.0, which means that UAssetAPI can be safely used with a variety of .NET Framework and .NET Core versions. We will start off in this specific guide by creating a new C# Console App project in Visual Studio, and we will target .NET Framework 4.7.2:

Once we have entered Visual Studio, we must add a new reference to our UAssetAPI.dll file. This can be done by right-clicking under "References," clicking "Add Reference," clicking "Browse" in the bottom right of the Reference Manager window, browsing to your UAssetAPI.dll file on disk, and clicking "OK".

Once you've referenced the UAssetAPI assembly in your project, you're ready to start parsing assets!

Using UAssetAPI with UE4 Assets

Modifying a specific property

Every Unreal Engine 4 parsed with UAssetAPI is represented by the UAsset class. The simplest way to construct a UAsset is to initialize it with the path to the asset on disk (note that if your asset has a paired .uexp file, both files must be located in the same directory, and the path should point to the .uasset file) and an EngineVersion.

I will be analyzing a small asset from the video game Ace Combat 7 (4.18) for this demonstration, which can be downloaded here:

• plwp_6aam_a0.uasset → C:\plwp_6aam_a0.uasset
• plwp_6aam_a0.uexp → C:\plwp_6aam_a0.uasset

Save these files to those respective locations.

If you are familiar with UAssetGUI or other tools for reverse-engineering Unreal Engine 4 assets, you will likely be aware that there are generally at least five major sections to any asset, each of which can be read and modified through UAssetAPI as listed under the "Accessing Data" tab.

For now, let's simply modify an integer. If we open the asset in UAssetGUI and look under "Export Data," we can see all the exports that we can access; for our demonstrations, we're interested in Export 2, and we'll be modifying the "MaxRotationAngle" float.

Let's start programming! Head to the Program.cs file and use the following pre-written code, placed in static void Main(string[] args) (feel free to copy and paste):

// Instantiate the asset with the path and the engine version (4.18).
// This reads the entire asset to memory at once; use a different constructor with an AssetBinaryReader if you don't want that
UAsset myAsset = new UAsset("C:\\plwp_6aam_a0.uasset", EngineVersion.VER_UE4_18);

// We want the 2nd export, so we reference the export at index 1.
// There are many types, but any export that has regular "tagged" data like you see as properties in UAssetGUI can be cast to a NormalExport, like this one.
NormalExport myExport = (NormalExport)myAsset.Exports[1];

// myExport.Data will give us a List<PropertyData> which you can enumerate if you like, but we can reference a property by name or index with the export directly.
// We know this is a FloatPropertyData because it is serialized as a FloatProperty. BoolPropertyData is a BoolProperty, ObjectPropertyData is an ObjectProperty, etc.
FloatPropertyData myFloat = (FloatPropertyData)myExport["MaxRotationAngle"];
Console.WriteLine(myFloat.Value);

// All we have to do to change this value is to set myFloat.Value, and we'll be ready to re-save the asset.
myFloat.Value = 1337;

// Save the asset back to disk with UAsset.Write and a path.
myAsset.Write("NEW.uasset");

Console.WriteLine("All done!");
Console.ReadLine();

The above code is an example on how we can pinpoint and modify a specific asset; running it will output a NEW.uasset file in the current working directory (which you can access by right-clicking your project in the Solution Explorer, clicking "Open Folder in File Explorer", and navigating to "bin/Debug") with the modified float. You can verify the change for yourself in UAssetGUI.

More advanced modification

What if we don't know where the property is? If we don't know the exact contents of the asset before we load it, we may have to perform more advanced modification techniques based on what information we do know.

Let's say we want to modify a specific NameProperty called InternalVariableName in an export with the ObjectName SCS_Node_1 (you can see this in UAssetGUI under the Export Information tab). Using the same file as above, we'll need to iterate through our exports until we find the appropriate property:

// Instantiate the asset with the path and the engine version (4.18).
// This reads the entire asset to memory at once; use a different constructor with an AssetBinaryReader if you don't want that
UAsset myAsset = new UAsset("C:\\plwp_6aam_a0.uasset", EngineVersion.VER_UE4_18);

// Iterate through all the exports
foreach (Export export in myAsset.Exports)
{
    if (!(export is NormalExport normalExport)) continue; // We know our export is a NormalExport, so if this export isn't one, it's useless to us
    if (export.ObjectName.ToString() == "SCS_Node_1") // Check; do we have the right name?
    {
        // Create a new NamePropertyData with our desired value
        normalExport["InternalVariableName"].RawValue = FName.FromString(myAsset, "Howdy!");
        break;
    }
}

// Save the asset back to disk with UAsset.Write and a path.
myAsset.Write("NEW.uasset");

Console.WriteLine("All done!");
Console.ReadLine();

Under the scene, we're actually doing quite a lot here:

• First, we iterate through every export.
• For every export, if it's a NormalExport, we access its ObjectName field, which is an FName object. FName objects consist of two integers, an INDEX and a VALUE. When we convert it to a string, we access the name map with the INDEX to retrieve SCS_Node, and suffix it with the VALUE as _1.
• We access the InternalVariableName property, and set its RawValue property. RawValue is a property present on all PropertyData objects which simply allows you to access the object's Value field as an object. We could also do (NamePropertyData)(normalExport["InternalVariableName"]).Value here instead.
• We create a new FName object with FName.FromString, which performs the inverse operation of .ToString(). This method will automatically add an entry at the end of the name map.

At the end of the day, we have made no assumptions about the ordering of the exports or properties, and have still performed the operation.

Final Notes

UAssetAPI is only one layer of abstraction above the raw binary format, which means that it essentially gives you full access to every single aspect of a .uasset file. This means that performing very complex operations can be quite a challenge, so keep experimenting!

You may find it useful while learning to export assets into JSON through the .SerializeJSON() method or through UAssetGUI, as the JSON format very closely mirrors the way that assets are laid out in UAssetAPI. You can also find lots of examples for UAssetAPI syntax and usage in the unit tests.

AC7Decrypt

Namespace: UAssetAPI

Decryptor for Ace Combat 7 assets.

public class AC7Decrypt

Inheritance Object → AC7Decrypt

Constructors

AC7Decrypt()

public AC7Decrypt()

Methods

Decrypt(String, String)

Decrypts an Ace Combat 7 encrypted asset on disk.

public void Decrypt(string input, string output)

Parameters

input String
The path to an encrypted asset on disk.

output String
The path that the decrypted asset should be saved to.

Encrypt(String, String)

Encrypts an Ace Combat 7 encrypted asset on disk.

public void Encrypt(string input, string output)

Parameters

input String
The path to a decrypted asset on disk.

output String
The path that the encrypted asset should be saved to.

DecryptUAssetBytes(Byte[], AC7XorKey)

public Byte[] DecryptUAssetBytes(Byte[] uasset, AC7XorKey xorkey)

Parameters

uasset Byte[]

xorkey AC7XorKey

Returns

Byte[]

EncryptUAssetBytes(Byte[], AC7XorKey)

public Byte[] EncryptUAssetBytes(Byte[] uasset, AC7XorKey xorkey)

Parameters

uasset Byte[]

xorkey AC7XorKey

Returns

Byte[]

DecryptUexpBytes(Byte[], AC7XorKey)

public Byte[] DecryptUexpBytes(Byte[] uexp, AC7XorKey xorkey)

Parameters

uexp Byte[]

xorkey AC7XorKey

Returns

Byte[]

EncryptUexpBytes(Byte[], AC7XorKey)

public Byte[] EncryptUexpBytes(Byte[] uexp, AC7XorKey xorkey)

Parameters

uexp Byte[]

xorkey AC7XorKey

Returns

Byte[]

AC7XorKey

Namespace: UAssetAPI

XOR key for decrypting a particular Ace Combat 7 asset.

public class AC7XorKey

Inheritance Object → AC7XorKey

Fields

NameKey

public int NameKey;

Offset

public int Offset;

pk1

public int pk1;

pk2

public int pk2;

Constructors

AC7XorKey(String)

Generates an encryption key for a particular asset on disk.

public AC7XorKey(string fname)

Parameters

fname String
The name of the asset being encrypted on disk without the extension.

Methods

SkipCount(Int32)

public void SkipCount(int count)

Parameters

count Int32

AssetBinaryReader

Namespace: UAssetAPI

Reads primitive data types from Unreal Engine assets.

public class AssetBinaryReader : UnrealBinaryReader, System.IDisposable

Inheritance Object → BinaryReader → UnrealBinaryReader → AssetBinaryReader
Implements IDisposable

Fields

Asset

public UnrealPackage Asset;

Properties

BaseStream

public Stream BaseStream { get; }

Property Value

Stream

Constructors

AssetBinaryReader(Stream, UnrealPackage)

public AssetBinaryReader(Stream stream, UnrealPackage asset)

Parameters

stream Stream

asset UnrealPackage

Methods

ReadPropertyGuid()

public Nullable<Guid> ReadPropertyGuid()

Returns

Nullable<Guid>

ReadFName()

public FName ReadFName()

Returns

FName

XFERSTRING()

public string XFERSTRING()

Returns

String

XFERUNICODESTRING()

public string XFERUNICODESTRING()

Returns

String

XFERTEXT()

public void XFERTEXT()

XFERNAME()

public FName XFERNAME()

Returns

FName

XFER_FUNC_NAME()

public FName XFER_FUNC_NAME()

Returns

FName

XFERPTR()

public FPackageIndex XFERPTR()

Returns

FPackageIndex

XFER_FUNC_POINTER()

public FPackageIndex XFER_FUNC_POINTER()

Returns

FPackageIndex

XFER_PROP_POINTER()

public KismetPropertyPointer XFER_PROP_POINTER()

Returns

KismetPropertyPointer

XFER_OBJECT_POINTER()

public FPackageIndex XFER_OBJECT_POINTER()

Returns

FPackageIndex

ReadExpressionArray(EExprToken)

public KismetExpression[] ReadExpressionArray(EExprToken endToken)

Parameters

endToken EExprToken

Returns

KismetExpression[]

AssetBinaryWriter

Namespace: UAssetAPI

Writes primitive data types from Unreal Engine assets.

public class AssetBinaryWriter : UnrealBinaryWriter, System.IDisposable, System.IAsyncDisposable

Inheritance Object → BinaryWriter → UnrealBinaryWriter → AssetBinaryWriter
Implements IDisposable, IAsyncDisposable

Fields

Asset

public UnrealPackage Asset;

Properties

BaseStream

public Stream BaseStream { get; }

Property Value

Stream

Constructors

AssetBinaryWriter(UnrealPackage)

public AssetBinaryWriter(UnrealPackage asset)

Parameters

asset UnrealPackage

AssetBinaryWriter(Stream, UnrealPackage)

public AssetBinaryWriter(Stream stream, UnrealPackage asset)

Parameters

stream Stream

asset UnrealPackage

AssetBinaryWriter(Stream, Encoding, UnrealPackage)

public AssetBinaryWriter(Stream stream, Encoding encoding, UnrealPackage asset)

Parameters

stream Stream

encoding Encoding

asset UnrealPackage

AssetBinaryWriter(Stream, Encoding, Boolean, UnrealPackage)

public AssetBinaryWriter(Stream stream, Encoding encoding, bool leaveOpen, UnrealPackage asset)

Parameters

stream Stream

encoding Encoding

leaveOpen Boolean

asset UnrealPackage

Methods

Write(FName)

public void Write(FName name)

Parameters

name FName

WritePropertyGuid(Nullable<Guid>)

public void WritePropertyGuid(Nullable<Guid> guid)

Parameters

guid Nullable<Guid>

XFERSTRING(String)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFERSTRING(string val)

Parameters

val String

Returns

Int32

XFERUNICODESTRING(String)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFERUNICODESTRING(string val)

Parameters

val String

Returns

Int32

XFERNAME(FName)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFERNAME(FName val)

Parameters

val FName

Returns

Int32

XFER_FUNC_NAME(FName)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFER_FUNC_NAME(FName val)

Parameters

val FName

Returns

Int32

XFERPTR(FPackageIndex)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFERPTR(FPackageIndex val)

Parameters

val FPackageIndex

Returns

Int32

XFER_FUNC_POINTER(FPackageIndex)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFER_FUNC_POINTER(FPackageIndex val)

Parameters

val FPackageIndex

Returns

Int32

XFER_PROP_POINTER(KismetPropertyPointer)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFER_PROP_POINTER(KismetPropertyPointer val)

Parameters

val KismetPropertyPointer

Returns

Int32

XFER_OBJECT_POINTER(FPackageIndex)

This method is intended only to be used in parsing Kismet bytecode; please do not use it for any other purpose!

public int XFER_OBJECT_POINTER(FPackageIndex val)

Parameters

val FPackageIndex

Returns

Int32

CityHash

Namespace: UAssetAPI

public class CityHash

Inheritance Object → CityHash

Constructors

CityHash()

public CityHash()

Methods

CityHash32(Byte, UInt32)*

public static uint CityHash32(Byte* s, uint len)

Parameters

s Byte*

len UInt32

Returns

UInt32

CityHash64(Byte, UInt32)*

public static ulong CityHash64(Byte* s, uint len)

Parameters

s Byte*

len UInt32

Returns

UInt64

CityHash64WithSeed(Byte, UInt32, UInt64)*

public static ulong CityHash64WithSeed(Byte* s, uint len, ulong seed)

Parameters

s Byte*

len UInt32

seed UInt64

Returns

UInt64

CityHash64WithSeeds(Byte, UInt32, UInt64, UInt64)*

public static ulong CityHash64WithSeeds(Byte* s, uint len, ulong seed0, ulong seed1)

Parameters

s Byte*

len UInt32

seed0 UInt64

seed1 UInt64

Returns

UInt64

CityHash128to64(Uint128_64)

public static ulong CityHash128to64(Uint128_64 x)

Parameters

x Uint128_64

Returns

UInt64

CRCGenerator

Namespace: UAssetAPI

public static class CRCGenerator

Inheritance Object → CRCGenerator

Fields

CRCTable_DEPRECATED

public static UInt32[] CRCTable_DEPRECATED;

CRCTablesSB8

public static UInt32[,] CRCTablesSB8;

Methods

GenerateImportHashFromObjectPath(FString)

public static ulong GenerateImportHashFromObjectPath(FString text)

Parameters

text FString

Returns

UInt64

GenerateImportHashFromObjectPath(String)

public static ulong GenerateImportHashFromObjectPath(string text)

Parameters

text String

Returns

UInt64

CityHash64WithLower(FString)

public static ulong CityHash64WithLower(FString text)

Parameters

text FString

Returns

UInt64

CityHash64WithLower(String, Encoding)

public static ulong CityHash64WithLower(string text, Encoding encoding)

Parameters

text String

encoding Encoding

Returns

UInt64

CityHash64(FString)

public static ulong CityHash64(FString text)

Parameters

text FString

Returns

UInt64

CityHash64(String, Encoding)

public static ulong CityHash64(string text, Encoding encoding)

Parameters

text String

encoding Encoding

Returns

UInt64

CityHash64(Byte[])

public static ulong CityHash64(Byte[] data)

Parameters

data Byte[]

Returns

UInt64

GenerateHash(FString, Boolean)

public static uint GenerateHash(FString text, bool disableCasePreservingHash)

Parameters

text FString

disableCasePreservingHash Boolean

Returns

UInt32

GenerateHash(String, Boolean)

public static uint GenerateHash(string text, bool disableCasePreservingHash)

Parameters

text String

disableCasePreservingHash Boolean

Returns

UInt32

GenerateHash(String, Encoding, Boolean)

public static uint GenerateHash(string text, Encoding encoding, bool disableCasePreservingHash)

Parameters

text String

encoding Encoding

disableCasePreservingHash Boolean

Returns

UInt32

ToUpper(Char)

public static char ToUpper(char input)

Parameters

input Char

Returns

Char

ToUpper(String)

public static string ToUpper(string input)

Parameters

input String

Returns

String

ToLower(Char)

public static char ToLower(char input)

Parameters

input Char

Returns

Char

ToLower(String, Boolean)

public static string ToLower(string input, bool coalesceToSlash)

Parameters

input String

coalesceToSlash Boolean

Returns

String

ToLower(FString, Boolean)

public static FString ToLower(FString input, bool coalesceToSlash)

Parameters

input FString

coalesceToSlash Boolean

Returns

FString

Strihash_DEPRECATED(String, Encoding)

public static uint Strihash_DEPRECATED(string text, Encoding encoding)

Parameters

text String

encoding Encoding

Returns

UInt32

StrCrc32(String, UInt32)

public static uint StrCrc32(string text, uint CRC)

Parameters

text String

CRC UInt32

Returns

UInt32

CustomVersion

Namespace: UAssetAPI

A custom version. Controls more specific serialization than the main engine object version does.

public class CustomVersion

Inheritance Object → CustomVersion

Fields

Key

public Guid Key;

FriendlyName

public string FriendlyName;

Version

public int Version;

IsSerialized

public bool IsSerialized;

GuidToCustomVersionStringMap

Static map of custom version GUIDs to the object or enum that they represent in the Unreal Engine. This list is not necessarily exhaustive, so feel free to add to it if need be.

public static Dictionary<Guid, string> GuidToCustomVersionStringMap;

UnusedCustomVersionKey

A GUID that represents an unused custom version.

public static Guid UnusedCustomVersionKey;

Constructors

CustomVersion(String, Int32)

Initializes a new instance of the CustomVersion class given an object or enum name and a version number.

public CustomVersion(string friendlyName, int version)

Parameters

friendlyName String
The friendly name to use when initializing this custom version.

version Int32
The version number to use when initializing this custom version.

CustomVersion(Guid, Int32)

Initializes a new instance of the CustomVersion class given a custom version GUID and a version number.

public CustomVersion(Guid key, int version)

Parameters

key Guid
The GUID to use when initializing this custom version.

version Int32
The version number to use when initializing this custom version.

CustomVersion()

Initializes a new instance of the CustomVersion class.

public CustomVersion()

Methods

GetCustomVersionFriendlyNameFromGuid(Guid)

Returns the name of the object or enum that a custom version GUID represents, as specified in CustomVersion.GuidToCustomVersionStringMap.

public static string GetCustomVersionFriendlyNameFromGuid(Guid guid)

Parameters

guid Guid
A GUID that represents a custom version.

Returns

String
A string that represents the friendly name of the corresponding custom version.

GetCustomVersionGuidFromFriendlyName(String)

Returns the GUID of the custom version that the object or enum name provided represents.

public static Guid GetCustomVersionGuidFromFriendlyName(string friendlyName)

Parameters

friendlyName String
The name of a custom version object or enum.

Returns

Guid
A GUID that represents the custom version

SetIsSerialized(Boolean)

public CustomVersion SetIsSerialized(bool val)

Parameters

val Boolean

Returns

CustomVersion

FEngineVersion

Namespace: UAssetAPI

Holds basic Unreal version numbers.

public struct FEngineVersion

Inheritance Object → ValueType → FEngineVersion

Fields

Major

Major version number.

public ushort Major;

Minor

Minor version number.

public ushort Minor;

Patch

Patch version number.

public ushort Patch;

Changelist

Changelist number. This is used by the engine to arbitrate when Major/Minor/Patch version numbers match.

public uint Changelist;

Branch

Branch name.

public FString Branch;

Constructors

FEngineVersion(UnrealBinaryReader)

FEngineVersion(UnrealBinaryReader reader)

Parameters

reader UnrealBinaryReader

FEngineVersion(UInt16, UInt16, UInt16, UInt32, FString)

FEngineVersion(ushort major, ushort minor, ushort patch, uint changelist, FString branch)

Parameters

major UInt16

minor UInt16

patch UInt16

changelist UInt32

branch FString

Methods

Write(UnrealBinaryWriter)

void Write(UnrealBinaryWriter writer)

Parameters

writer UnrealBinaryWriter

FGenerationInfo

Namespace: UAssetAPI

Revision data for an Unreal package file.

public class FGenerationInfo

Inheritance Object → FGenerationInfo

Fields

ExportCount

Number of exports in the export map for this generation.

public int ExportCount;

NameCount

Number of names in the name map for this generation.

public int NameCount;

Constructors

FGenerationInfo(Int32, Int32)

public FGenerationInfo(int exportCount, int nameCount)

Parameters

exportCount Int32

nameCount Int32

Import

Namespace: UAssetAPI

UObject resource type for objects that are referenced by this package, but contained within another package.

public class Import

Inheritance Object → Import

Fields

ObjectName

The name of the UObject represented by this resource.

public FName ObjectName;

OuterIndex

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage

public FPackageIndex OuterIndex;

ClassPackage

public FName ClassPackage;

ClassName

public FName ClassName;

bImportOptional

public bool bImportOptional;

Constructors

Import(String, String, FPackageIndex, String, Boolean, UAsset)

public Import(string classPackage, string className, FPackageIndex outerIndex, string objectName, bool importOptional, UAsset asset)

Parameters

classPackage String

className String

outerIndex FPackageIndex

objectName String

importOptional Boolean

asset UAsset

Import(FName, FName, FPackageIndex, FName, Boolean)

public Import(FName classPackage, FName className, FPackageIndex outerIndex, FName objectName, bool importOptional)

Parameters

classPackage FName

className FName

outerIndex FPackageIndex

objectName FName

importOptional Boolean

Import(AssetBinaryReader)

public Import(AssetBinaryReader reader)

Parameters

reader AssetBinaryReader

Import()

public Import()

InvalidMappingsException

Namespace: UAssetAPI

public class InvalidMappingsException : System.InvalidOperationException, System.Runtime.Serialization.ISerializable

Inheritance Object → Exception → SystemException → InvalidOperationException → InvalidMappingsException
Implements ISerializable

Properties

TargetSite

public MethodBase TargetSite { get; }

Property Value

MethodBase

Message

public string Message { get; }

Property Value

String

Data

public IDictionary Data { get; }

Property Value

IDictionary

InnerException

public Exception InnerException { get; }

Property Value

Exception

HelpLink

public string HelpLink { get; set; }

Property Value

String

Source

public string Source { get; set; }

Property Value

String

HResult

public int HResult { get; set; }

Property Value

Int32

StackTrace

public string StackTrace { get; }

Property Value

String

Constructors

InvalidMappingsException(String)

public InvalidMappingsException(string message)

Parameters

message String

MainSerializer

Namespace: UAssetAPI

The main serializer for most property types in UAssetAPI.

public static class MainSerializer

Inheritance Object → MainSerializer

Methods

GetNamesOfAssembliesReferencedBy(Assembly)

public static IEnumerable<string> GetNamesOfAssembliesReferencedBy(Assembly assembly)

Parameters

assembly Assembly

Returns

IEnumerable<String>

GenerateUnversionedHeader(List`1&, FName, UnrealPackage)

Generates an unversioned header based on a list of properties, and sorts the list in the correct order to be serialized.

public static FUnversionedHeader GenerateUnversionedHeader(List`1& data, FName parentName, UnrealPackage asset)

Parameters

data List`1&
The list of properties to sort and generate an unversioned header from.

parentName FName
The name of the parent of all the properties.

asset UnrealPackage
The UnrealPackage which the properties are contained within.

Returns

FUnversionedHeader

TypeToClass(FName, FName, AncestryInfo, FName, UnrealPackage, AssetBinaryReader, Int32, Int32, Boolean, Boolean)

Initializes the correct PropertyData class based off of serialized name, type, etc.

public static PropertyData TypeToClass(FName type, FName name, AncestryInfo ancestry, FName parentName, UnrealPackage asset, AssetBinaryReader reader, int leng, int duplicationIndex, bool includeHeader, bool isZero)

Parameters

type FName
The serialized type of this property.

name FName
The serialized name of this property.

ancestry AncestryInfo
The ancestry of the parent of this property.

parentName FName
The name of the parent class/struct of this property.

asset UnrealPackage
The UnrealPackage which this property is contained within.

reader AssetBinaryReader
The BinaryReader to read from. If left unspecified, you must call the method manually.

leng Int32
The length of this property on disk in bytes.

duplicationIndex Int32
The duplication index of this property.

includeHeader Boolean
Does this property serialize its header in the current context?

isZero Boolean
Is the body of this property empty?

Returns

PropertyData
A new PropertyData instance based off of the passed parameters.

Read(AssetBinaryReader, AncestryInfo, FName, FUnversionedHeader, Boolean)

Reads a property into memory.

public static PropertyData Read(AssetBinaryReader reader, AncestryInfo ancestry, FName parentName, FUnversionedHeader header, bool includeHeader)

Parameters

reader AssetBinaryReader
The BinaryReader to read from. The underlying stream should be at the position of the property to be read.

ancestry AncestryInfo
The ancestry of the parent of this property.

parentName FName
The name of the parent class/struct of this property.

header FUnversionedHeader
The unversioned header to be used when reading this property. Leave null if none exists.

includeHeader Boolean
Does this property serialize its header in the current context?

Returns

PropertyData
The property read from disk.

ReadFProperty(AssetBinaryReader)

Reads an FProperty into memory. Primarily used as a part of StructExport serialization.

public static FProperty ReadFProperty(AssetBinaryReader reader)

Parameters

reader AssetBinaryReader
The BinaryReader to read from. The underlying stream should be at the position of the FProperty to be read.

Returns

FProperty
The FProperty read from disk.

WriteFProperty(FProperty, AssetBinaryWriter)

Serializes an FProperty from memory.

public static void WriteFProperty(FProperty prop, AssetBinaryWriter writer)

Parameters

prop FProperty
The FProperty to serialize.

writer AssetBinaryWriter
The BinaryWriter to serialize the FProperty to.

ReadUProperty(AssetBinaryReader, FName)

Reads a UProperty into memory. Primarily used as a part of PropertyExport serialization.

public static UProperty ReadUProperty(AssetBinaryReader reader, FName serializedType)

Parameters

reader AssetBinaryReader
The BinaryReader to read from. The underlying stream should be at the position of the UProperty to be read.

serializedType FName
The type of UProperty to be read.

Returns

UProperty
The FProperty read from disk.

ReadUProperty(AssetBinaryReader, Type)

Reads a UProperty into memory. Primarily used as a part of PropertyExport serialization.

public static UProperty ReadUProperty(AssetBinaryReader reader, Type requestedType)

Parameters

reader AssetBinaryReader
The BinaryReader to read from. The underlying stream should be at the position of the UProperty to be read.

requestedType Type
The type of UProperty to be read.

Returns

UProperty
The FProperty read from disk.

ReadUProperty<T>(AssetBinaryReader)

Reads a UProperty into memory. Primarily used as a part of PropertyExport serialization.

public static T ReadUProperty<T>(AssetBinaryReader reader)

Type Parameters

T

Parameters

reader AssetBinaryReader
The BinaryReader to read from. The underlying stream should be at the position of the UProperty to be read.

Returns

T
The FProperty read from disk.

WriteUProperty(UProperty, AssetBinaryWriter)

Serializes a UProperty from memory.

public static void WriteUProperty(UProperty prop, AssetBinaryWriter writer)

Parameters

prop UProperty
The UProperty to serialize.

writer AssetBinaryWriter
The BinaryWriter to serialize the UProperty to.

Write(PropertyData, AssetBinaryWriter, Boolean)

Serializes a property from memory.

public static int Write(PropertyData property, AssetBinaryWriter writer, bool includeHeader)

Parameters

property PropertyData
The property to serialize.

writer AssetBinaryWriter
The BinaryWriter to serialize the property to.

includeHeader Boolean
Does this property serialize its header in the current context?

Returns

Int32
The serial offset where the length of the property is stored.

NameMapOutOfRangeException

Namespace: UAssetAPI

public class NameMapOutOfRangeException : System.FormatException, System.Runtime.Serialization.ISerializable

Inheritance Object → Exception → SystemException → FormatException → NameMapOutOfRangeException
Implements ISerializable

Fields

RequiredName

public FString RequiredName;

Properties

TargetSite

public MethodBase TargetSite { get; }

Property Value

MethodBase

Message

public string Message { get; }

Property Value

String

Data

public IDictionary Data { get; }

Property Value

IDictionary

InnerException

public Exception InnerException { get; }

Property Value

Exception

HelpLink

public string HelpLink { get; set; }

Property Value

String

Source

public string Source { get; set; }

Property Value

String

HResult

public int HResult { get; set; }

Property Value

Int32

StackTrace

public string StackTrace { get; }

Property Value

String

Constructors

NameMapOutOfRangeException(FString)

public NameMapOutOfRangeException(FString requiredName)

Parameters

requiredName FString

UAPUtils

Namespace: UAssetAPI

public static class UAPUtils

Inheritance Object → UAPUtils

Fields

CurrentCommit

public static string CurrentCommit;

Methods

SerializeJson(Object, Boolean)

public static string SerializeJson(object obj, bool isFormatted)

Parameters

obj Object

isFormatted Boolean

Returns

String

FindAllInstances<T>(Object)

public static List<T> FindAllInstances<T>(object parent)

Type Parameters

T

Parameters

parent Object

Returns

List<T>

Clamp<T>(T, T, T)

public static T Clamp<T>(T val, T min, T max)

Type Parameters

T

Parameters

val T

min T

max T

Returns

T

GetOrderedFields<T>()

public static FieldInfo[] GetOrderedFields<T>()

Type Parameters

T

Returns

FieldInfo[]

GetOrderedFields(Type)

public static FieldInfo[] GetOrderedFields(Type t)

Parameters

t Type

Returns

FieldInfo[]

GetOrderedMembers<T>()

public static MemberInfo[] GetOrderedMembers<T>()

Type Parameters

T

Returns

MemberInfo[]

GetOrderedMembers(Type)

public static MemberInfo[] GetOrderedMembers(Type t)

Parameters

t Type

Returns

MemberInfo[]

GetValue(MemberInfo, Object)

public static object GetValue(MemberInfo memberInfo, object forObject)

Parameters

memberInfo MemberInfo

forObject Object

Returns

Object

SetValue(MemberInfo, Object, Object)

public static void SetValue(MemberInfo memberInfo, object forObject, object forVal)

Parameters

memberInfo MemberInfo

forObject Object

forVal Object

GetImportNameReferenceWithoutZero(Int32, UAsset)

public static FString GetImportNameReferenceWithoutZero(int j, UAsset asset)

Parameters

j Int32

asset UAsset

Returns

FString

InterpretAsGuidAndConvertToUnsignedInts(String)

public static UInt32[] InterpretAsGuidAndConvertToUnsignedInts(string value)

Parameters

value String

Returns

UInt32[]

ToUnsignedInts(Guid)

public static UInt32[] ToUnsignedInts(Guid value)

Parameters

value Guid

Returns

UInt32[]

GUID(UInt32, UInt32, UInt32, UInt32)

public static Guid GUID(uint value1, uint value2, uint value3, uint value4)

Parameters

value1 UInt32

value2 UInt32

value3 UInt32

value4 UInt32

Returns

Guid

ConvertToGUID(String)

public static Guid ConvertToGUID(string GuidString)

Parameters

GuidString String

Returns

Guid

ConvertToString(Guid)

public static string ConvertToString(Guid val)

Parameters

val Guid

Returns

String

ConvertHexStringToByteArray(String)

public static Byte[] ConvertHexStringToByteArray(string hexString)

Parameters

hexString String

Returns

Byte[]

AlignPadding(Int64, Int32)

public static long AlignPadding(long pos, int align)

Parameters

pos Int64

align Int32

Returns

Int64

AlignPadding(Int32, Int32)

public static int AlignPadding(int pos, int align)

Parameters

pos Int32

align Int32

Returns

Int32

DivideAndRoundUp(Int32, Int32)

public static int DivideAndRoundUp(int a, int b)

Parameters

a Int32

b Int32

Returns

Int32

UAsset

Namespace: UAssetAPI

Represents an Unreal Engine asset.

public class UAsset : UnrealPackage, UAssetAPI.IO.INameMap

Inheritance Object → UnrealPackage → UAsset
Implements INameMap

Fields

LegacyFileVersion

The package file version number when this package was saved.

public int LegacyFileVersion;

Remarks:

The lower 16 bits stores the UE3 engine version, while the upper 16 bits stores the UE4/licensee version. For newer packages this is -7. VersionDescription-2indicates presence of enum-based custom versions-3indicates guid-based custom versions-4indicates removal of the UE3 version. Packages saved with this ID cannot be loaded in older engine versions-5indicates the replacement of writing out the "UE3 version" so older versions of engine can gracefully fail to open newer packages-6indicates optimizations to how custom versions are being serialized-7indicates the texture allocation info has been removed from the summary-8indicates that the UE5 version has been added to the summary

UsesEventDrivenLoader

Whether or not this asset is loaded with the Event Driven Loader.

public bool UsesEventDrivenLoader;

WillSerializeNameHashes

Whether or not this asset serializes hashes in the name map. If null, this will be automatically determined based on the object version.

public Nullable<bool> WillSerializeNameHashes;

Imports

Map of object imports. UAssetAPI used to call these "links."

public List<Import> Imports;

DependsMap

List of dependency lists for each export.

public List<Int32[]> DependsMap;

SoftPackageReferenceList

List of packages that are soft referenced by this package.

public List<FString> SoftPackageReferenceList;

AssetRegistryData

Uncertain

public Byte[] AssetRegistryData;

ValorantGarbageData

Some garbage data that appears to be present in certain games (e.g. Valorant)

public Byte[] ValorantGarbageData;

Generations

Data about previous versions of this package.

public List<FGenerationInfo> Generations;

PackageGuid

Current ID for this package. Effectively unused.

public Guid PackageGuid;

RecordedEngineVersion

Engine version this package was saved with. This may differ from CompatibleWithEngineVersion for assets saved with a hotfix release.

public FEngineVersion RecordedEngineVersion;

RecordedCompatibleWithEngineVersion

Engine version this package is compatible with. Assets saved by Hotfix releases and engine versions that maintain binary compatibility will have a CompatibleWithEngineVersion.Patch that matches the original release (as opposed to SavedByEngineVersion which will have a patch version of the new release).

public FEngineVersion RecordedCompatibleWithEngineVersion;

ChunkIDs

Streaming install ChunkIDs

public Int32[] ChunkIDs;

PackageSource

Value that is used by the Unreal Engine to determine if the package was saved by Epic, a licensee, modder, etc.

public uint PackageSource;

FolderName

The Generic Browser folder name that this package lives in. Usually "None" in cooked assets.

public FString FolderName;

OverrideNameMapHashes

A map of name map entries to hashes to use when serializing instead of the default engine hash algorithm. Useful when external programs improperly specify name map hashes and binary equality must be maintained.

public Dictionary<FString, uint> OverrideNameMapHashes;

UASSET_MAGIC

Magic number for the .uasset format

public static uint UASSET_MAGIC;

ACE7_MAGIC

Magic number for Ace Combat 7 encrypted .uasset format

public static uint ACE7_MAGIC;

Info

Agent string to provide context in serialized JSON.

public string Info;

FilePath

The path of the file on disk that this asset represents. This does not need to be specified for regular parsing.

public string FilePath;

Mappings

The corresponding mapping data for the game that this asset is from. Optional unless unversioned properties are present.

public Usmap Mappings;

UseSeparateBulkDataFiles

Should the asset be split into separate .uasset, .uexp, and .ubulk files, as opposed to one single .uasset file?

public bool UseSeparateBulkDataFiles;

IsUnversioned

Should this asset not serialize its engine and custom versions?

public bool IsUnversioned;

FileVersionLicenseeUE

The licensee file version. Used by some games to add their own Engine-level versioning.

public int FileVersionLicenseeUE;

ObjectVersion

The object version of UE4 that will be used to parse this asset.

public ObjectVersion ObjectVersion;

ObjectVersionUE5

The object version of UE5 that will be used to parse this asset. Set to ObjectVersionUE5.UNKNOWN for UE4 games.

public ObjectVersionUE5 ObjectVersionUE5;

CustomVersionContainer

All the custom versions stored in the archive.

public List<CustomVersion> CustomVersionContainer;

Exports

Map of object exports. UAssetAPI used to call these "categories."

public List<Export> Exports;

WorldTileInfo

Tile information used by WorldComposition. Defines properties necessary for tile positioning in the world.

public FWorldTileInfo WorldTileInfo;

MapStructTypeOverride

In MapProperties that have StructProperties as their keys or values, there is no universal, context-free way to determine the type of the struct.

To that end, this dictionary maps MapProperty names to the type of the structs within them (tuple of key struct type and value struct type) if they are not None-terminated property lists.

public Dictionary<string, Tuple<FString, FString>> MapStructTypeOverride;

ArrayStructTypeOverride

IN ENGINE VERSIONS BEFORE ObjectVersion.VER_UE4_INNER_ARRAY_TAG_INFO:

In ArrayProperties that have StructProperties as their keys or values, there is no universal, context-free way to determine the type of the struct. To that end, this dictionary maps ArrayProperty names to the type of the structs within them.

public Dictionary<string, FString> ArrayStructTypeOverride;

Properties

PackageFlags

The flags for this package.

public EPackageFlags PackageFlags { get; set; }

Property Value

EPackageFlags

HasUnversionedProperties

Whether or not this asset uses unversioned properties.

public bool HasUnversionedProperties { get; }

Property Value

Boolean

Constructors

UAsset(String, EngineVersion, Usmap)

Reads an asset from disk and initializes a new instance of the UAsset class to store its data in memory.

public UAsset(string path, EngineVersion engineVersion, Usmap mappings)

Parameters

path String
The path of the asset file on disk that this instance will read from.

engineVersion EngineVersion
The version of the Unreal Engine that will be used to parse this asset. If the asset is versioned, this can be left unspecified.

mappings Usmap
A valid set of mappings for the game that this asset is from. Not required unless unversioned properties are used.

Exceptions

UnknownEngineVersionException
Thrown when this is an unversioned asset and is unspecified.

FormatException
Throw when the asset cannot be parsed correctly.

UAsset(AssetBinaryReader, EngineVersion, Usmap, Boolean)

Reads an asset from a BinaryReader and initializes a new instance of the UAsset class to store its data in memory.

public UAsset(AssetBinaryReader reader, EngineVersion engineVersion, Usmap mappings, bool useSeparateBulkDataFiles)

Parameters

reader AssetBinaryReader
The asset's BinaryReader that this instance will read from. If a .uexp file exists, the .uexp file's data should be appended to the end of the .uasset file's data.

engineVersion EngineVersion
The version of the Unreal Engine that will be used to parse this asset. If the asset is versioned, this can be left unspecified.

mappings Usmap
A valid set of mappings for the game that this asset is from. Not required unless unversioned properties are used.

useSeparateBulkDataFiles Boolean
Does this asset uses separate bulk data files (.uexp, .ubulk)?

Exceptions

UnknownEngineVersionException
Thrown when this is an unversioned asset and is unspecified.

FormatException
Throw when the asset cannot be parsed correctly.

UAsset(EngineVersion, Usmap)

Initializes a new instance of the UAsset class. This instance will store no asset data and does not represent any asset in particular until the UAsset.Read(AssetBinaryReader, Int32[], Int32[]) method is manually called.

public UAsset(EngineVersion engineVersion, Usmap mappings)

Parameters

engineVersion EngineVersion
The version of the Unreal Engine that will be used to parse this asset. If the asset is versioned, this can be left unspecified.

mappings Usmap
A valid set of mappings for the game that this asset is from. Not required unless unversioned properties are used.

UAsset(String, ObjectVersion, ObjectVersionUE5, List<CustomVersion>, Usmap)

Reads an asset from disk and initializes a new instance of the UAsset class to store its data in memory.

public UAsset(string path, ObjectVersion objectVersion, ObjectVersionUE5 objectVersionUE5, List<CustomVersion> customVersionContainer, Usmap mappings)

Parameters

path String
The path of the asset file on disk that this instance will read from.

objectVersion ObjectVersion
The UE4 object version of the Unreal Engine that will be used to parse this asset.

objectVersionUE5 ObjectVersionUE5
The UE5 object version of the Unreal Engine that will be used to parse this asset.

customVersionContainer List<CustomVersion>
A list of custom versions to parse this asset with.

mappings Usmap
A valid set of mappings for the game that this asset is from. Not required unless unversioned properties are used.

Exceptions

UnknownEngineVersionException
Thrown when this is an unversioned asset and is unspecified.

FormatException
Throw when the asset cannot be parsed correctly.

UAsset(AssetBinaryReader, ObjectVersion, ObjectVersionUE5, List<CustomVersion>, Usmap, Boolean)

Reads an asset from a BinaryReader and initializes a new instance of the UAsset class to store its data in memory.

public UAsset(AssetBinaryReader reader, ObjectVersion objectVersion, ObjectVersionUE5 objectVersionUE5, List<CustomVersion> customVersionContainer, Usmap mappings, bool useSeparateBulkDataFiles)

Parameters

reader AssetBinaryReader
The asset's BinaryReader that this instance will read from.

objectVersion ObjectVersion
The UE4 object version of the Unreal Engine that will be used to parse this asset.

objectVersionUE5 ObjectVersionUE5
The UE5 object version of the Unreal Engine that will be used to parse this asset.

customVersionContainer List<CustomVersion>
A list of custom versions to parse this asset with.

mappings Usmap
A valid set of mappings for the game that this asset is from. Not required unless unversioned properties are used.

useSeparateBulkDataFiles Boolean
Does this asset uses separate bulk data files (.uexp, .ubulk)?

Exceptions

UnknownEngineVersionException
Thrown when this is an unversioned asset and is unspecified.

FormatException
Throw when the asset cannot be parsed correctly.

UAsset(ObjectVersion, ObjectVersionUE5, List<CustomVersion>, Usmap)

Initializes a new instance of the UAsset class. This instance will store no asset data and does not represent any asset in particular until the UAsset.Read(AssetBinaryReader, Int32[], Int32[]) method is manually called.

public UAsset(ObjectVersion objectVersion, ObjectVersionUE5 objectVersionUE5, List<CustomVersion> customVersionContainer, Usmap mappings)

Parameters

objectVersion ObjectVersion
The UE4 object version of the Unreal Engine that will be used to parse this asset.

objectVersionUE5 ObjectVersionUE5
The UE5 object version of the Unreal Engine that will be used to parse this asset.

customVersionContainer List<CustomVersion>
A list of custom versions to parse this asset with.

mappings Usmap
A valid set of mappings for the game that this asset is from. Not required unless unversioned properties are used.

UAsset()

Initializes a new instance of the UAsset class. This instance will store no asset data and does not represent any asset in particular until the UAsset.Read(AssetBinaryReader, Int32[], Int32[]) method is manually called.

public UAsset()

Methods

VerifyBinaryEquality()

Checks whether or not this asset maintains binary equality when serialized.

public bool VerifyBinaryEquality()

Returns

Boolean
Whether or not the asset maintained binary equality.

GetParentClass(FName&, FName&)

Finds the class path and export name of the SuperStruct of this asset, if it exists.

public void GetParentClass(FName& parentClassPath, FName& parentClassExportName)

Parameters

parentClassPath FName&
The class path of the SuperStruct of this asset, if it exists.

parentClassExportName FName&
The export name of the SuperStruct of this asset, if it exists.

GetParentClassExportName()

internal FName GetParentClassExportName()

Returns

FName

AddImport(Import)

Adds a new import to the import map. This is equivalent to adding directly to the UAsset.Imports list.

public FPackageIndex AddImport(Import li)

Parameters

li Import
The new import to add to the import map.

Returns

FPackageIndex
The FPackageIndex corresponding to the newly-added import.

SearchForImport(FName, FName, FPackageIndex, FName)

Searches for an import in the import map based off of certain parameters.

public int SearchForImport(FName classPackage, FName className, FPackageIndex outerIndex, FName objectName)

Parameters

classPackage FName
The ClassPackage that the requested import will have.

className FName
The ClassName that the requested import will have.

outerIndex FPackageIndex
The CuterIndex that the requested import will have.

objectName FName
The ObjectName that the requested import will have.

Returns

Int32
The index of the requested import in the name map, or zero if one could not be found.

SearchForImport(FName, FName, FName)

Searches for an import in the import map based off of certain parameters.

public int SearchForImport(FName classPackage, FName className, FName objectName)

Parameters

classPackage FName
The ClassPackage that the requested import will have.

className FName
The ClassName that the requested import will have.

objectName FName
The ObjectName that the requested import will have.

Returns

Int32
The index of the requested import in the name map, or zero if one could not be found.

SearchForImport(FName)

Searches for an import in the import map based off of certain parameters.

public int SearchForImport(FName objectName)

Parameters

objectName FName
The ObjectName that the requested import will have.

Returns

Int32
The index of the requested import in the name map, or zero if one could not be found.

CopySplitUp(Stream, Stream, Int32, Int32)

Copies a portion of a stream to another stream.

internal static void CopySplitUp(Stream input, Stream output, int start, int leng)

Parameters

input Stream
The input stream.

output Stream
The output stream.

start Int32
The offset in the input stream to start copying from.

leng Int32
The length in bytes of the data to be copied.

Read(AssetBinaryReader, Int32[], Int32[])

Reads an asset into memory.

public void Read(AssetBinaryReader reader, Int32[] manualSkips, Int32[] forceReads)

Parameters

reader AssetBinaryReader
The input reader.

manualSkips Int32[]
An array of export indexes to skip parsing. For most applications, this should be left blank.

forceReads Int32[]
An array of export indexes that must be read, overriding entries in the manualSkips parameter. For most applications, this should be left blank.

Exceptions

UnknownEngineVersionException
Thrown when this is an unversioned asset and is unspecified.

FormatException
Throw when the asset cannot be parsed correctly.

WriteData()

Serializes an asset from memory.

public MemoryStream WriteData()

Returns

MemoryStream
A new MemoryStream containing the full binary data of the serialized asset.

Write(String)

Serializes and writes an asset to disk from memory.

public void Write(string outputPath)

Parameters

outputPath String
The path on disk to write the asset to.

Exceptions

UnknownEngineVersionException
Thrown when is unspecified.

SerializeJson(Boolean)

Serializes this asset as JSON.

public string SerializeJson(bool isFormatted)

Parameters

isFormatted Boolean
Whether or not the returned JSON string should be indented.

Returns

String
A serialized JSON string that represents the asset.

SerializeJson(Formatting)

Serializes this asset as JSON.

public string SerializeJson(Formatting jsonFormatting)

Parameters

jsonFormatting Formatting
The formatting to use for the returned JSON string.

Returns

String
A serialized JSON string that represents the asset.

SerializeJsonObject(Object, Boolean)

Serializes an object as JSON.

public string SerializeJsonObject(object value, bool isFormatted)

Parameters

value Object
The object to serialize as JSON.

isFormatted Boolean
Whether or not the returned JSON string should be indented.

Returns

String
A serialized JSON string that represents the object.

SerializeJsonObject(Object, Formatting)

Serializes an object as JSON.

public string SerializeJsonObject(object value, Formatting jsonFormatting)

Parameters

value Object
The object to serialize as JSON.

jsonFormatting Formatting
The formatting to use for the returned JSON string.

Returns

String
A serialized JSON string that represents the object.

DeserializeJsonObject(String)

Deserializes an object from JSON.

public object DeserializeJsonObject(string json)

Parameters

json String
A serialized JSON string to parse.

Returns

Object

DeserializeJson(String)

Reads an asset from serialized JSON and initializes a new instance of the UAsset class to store its data in memory.

public static UAsset DeserializeJson(string json)

Parameters

json String
A serialized JSON string to parse.

Returns

UAsset

DeserializeJson(Stream)

Reads an asset from serialized JSON and initializes a new instance of the UAsset class to store its data in memory.

public static UAsset DeserializeJson(Stream stream)

Parameters

stream Stream
A stream containing serialized JSON string to parse.

Returns

UAsset

UnknownEngineVersionException

Namespace: UAssetAPI

public class UnknownEngineVersionException : System.InvalidOperationException, System.Runtime.Serialization.ISerializable

Inheritance Object → Exception → SystemException → InvalidOperationException → UnknownEngineVersionException
Implements ISerializable

Properties

TargetSite

public MethodBase TargetSite { get; }

Property Value

MethodBase

Message

public string Message { get; }

Property Value

String

Data

public IDictionary Data { get; }

Property Value

IDictionary

InnerException

public Exception InnerException { get; }

Property Value

Exception

HelpLink

public string HelpLink { get; set; }

Property Value

String

Source

public string Source { get; set; }

Property Value

String

HResult

public int HResult { get; set; }

Property Value

Int32

StackTrace

public string StackTrace { get; }

Property Value

String

Constructors

UnknownEngineVersionException(String)

public UnknownEngineVersionException(string message)

Parameters

message String

UnrealBinaryReader

Namespace: UAssetAPI

Any binary reader used in the parsing of Unreal file types.

public class UnrealBinaryReader : System.IO.BinaryReader, System.IDisposable

Inheritance Object → BinaryReader → UnrealBinaryReader
Implements IDisposable

Properties

BaseStream

public Stream BaseStream { get; }

Property Value

Stream

Constructors

UnrealBinaryReader(Stream)

public UnrealBinaryReader(Stream stream)

Parameters

stream Stream

Methods

ReverseIfBigEndian(Byte[])

protected Byte[] ReverseIfBigEndian(Byte[] data)

Parameters

data Byte[]

Returns

Byte[]

ReadInt16()

public short ReadInt16()

Returns

Int16

ReadUInt16()

public ushort ReadUInt16()

Returns

UInt16

ReadInt32()

public int ReadInt32()

Returns

Int32

ReadUInt32()

public uint ReadUInt32()

Returns

UInt32

ReadInt64()

public long ReadInt64()

Returns

Int64

ReadUInt64()

public ulong ReadUInt64()

Returns

UInt64

ReadSingle()

public float ReadSingle()

Returns

Single

ReadDouble()

public double ReadDouble()

Returns

Double

ReadString()

public string ReadString()

Returns

String

ReadFString(FSerializedNameHeader)

public FString ReadFString(FSerializedNameHeader nameHeader)

Parameters

nameHeader FSerializedNameHeader

Returns

FString

ReadNameMapString(FSerializedNameHeader, UInt32&)

public FString ReadNameMapString(FSerializedNameHeader nameHeader, UInt32& hashes)

Parameters

nameHeader FSerializedNameHeader

hashes UInt32&

Returns

FString

ReadNameBatch(Boolean, UInt64&, List`1&)

public void ReadNameBatch(bool VerifyHashes, UInt64& HashVersion, List`1& nameMap)

Parameters

VerifyHashes Boolean

HashVersion UInt64&

nameMap List`1&

ReadCustomVersionContainer(ECustomVersionSerializationFormat, List<CustomVersion>, Usmap)

public List<CustomVersion> ReadCustomVersionContainer(ECustomVersionSerializationFormat format, List<CustomVersion> oldCustomVersionContainer, Usmap Mappings)

Parameters

format ECustomVersionSerializationFormat

oldCustomVersionContainer List<CustomVersion>

Mappings Usmap

Returns

List<CustomVersion>

UnrealBinaryWriter

Namespace: UAssetAPI

Any binary writer used in the parsing of Unreal file types.

public class UnrealBinaryWriter : System.IO.BinaryWriter, System.IDisposable, System.IAsyncDisposable

Inheritance Object → BinaryWriter → UnrealBinaryWriter
Implements IDisposable, IAsyncDisposable

Properties

BaseStream

public Stream BaseStream { get; }

Property Value

Stream

Constructors

UnrealBinaryWriter()

public UnrealBinaryWriter()

UnrealBinaryWriter(Stream)

public UnrealBinaryWriter(Stream stream)

Parameters

stream Stream

UnrealBinaryWriter(Stream, Encoding)

public UnrealBinaryWriter(Stream stream, Encoding encoding)

Parameters

stream Stream

encoding Encoding

UnrealBinaryWriter(Stream, Encoding, Boolean)

public UnrealBinaryWriter(Stream stream, Encoding encoding, bool leaveOpen)

Parameters

stream Stream

encoding Encoding

leaveOpen Boolean

Methods

ReverseIfBigEndian(Byte[])

protected Byte[] ReverseIfBigEndian(Byte[] data)

Parameters

data Byte[]

Returns

Byte[]

Write(Int16)

public void Write(short value)

Parameters

value Int16

Write(UInt16)

public void Write(ushort value)

Parameters

value UInt16

Write(Int32)

public void Write(int value)

Parameters

value Int32

Write(UInt32)

public void Write(uint value)

Parameters

value UInt32

Write(Int64)

public void Write(long value)

Parameters

value Int64

Write(UInt64)

public void Write(ulong value)

Parameters

value UInt64

Write(Single)

public void Write(float value)

Parameters

value Single

Write(Double)

public void Write(double value)

Parameters

value Double

Write(String)

public void Write(string value)

Parameters

value String

Write(FString)

public int Write(FString value)

Parameters

value FString

Returns

Int32

WriteNameBatch(UInt64, IList<FString>)

public void WriteNameBatch(ulong HashVersion, IList<FString> nameMap)

Parameters

HashVersion UInt64

nameMap IList<FString>

WriteCustomVersionContainer(ECustomVersionSerializationFormat, List<CustomVersion>)

public void WriteCustomVersionContainer(ECustomVersionSerializationFormat format, List<CustomVersion> CustomVersionContainer)

Parameters

format ECustomVersionSerializationFormat

CustomVersionContainer List<CustomVersion>

UnrealPackage

Namespace: UAssetAPI

public abstract class UnrealPackage : UAssetAPI.IO.INameMap

Inheritance Object → UnrealPackage
Implements INameMap

Fields

Info

Agent string to provide context in serialized JSON.

public string Info;

FilePath

The path of the file on disk that this asset represents. This does not need to be specified for regular parsing.

public string FilePath;

Mappings

The corresponding mapping data for the game that this asset is from. Optional unless unversioned properties are present.

public Usmap Mappings;

UseSeparateBulkDataFiles

Should the asset be split into separate .uasset, .uexp, and .ubulk files, as opposed to one single .uasset file?

public bool UseSeparateBulkDataFiles;

IsUnversioned

Should this asset not serialize its engine and custom versions?

public bool IsUnversioned;

FileVersionLicenseeUE

The licensee file version. Used by some games to add their own Engine-level versioning.

public int FileVersionLicenseeUE;

ObjectVersion

The object version of UE4 that will be used to parse this asset.

public ObjectVersion ObjectVersion;

ObjectVersionUE5

The object version of UE5 that will be used to parse this asset. Set to ObjectVersionUE5.UNKNOWN for UE4 games.

public ObjectVersionUE5 ObjectVersionUE5;

CustomVersionContainer

All the custom versions stored in the archive.

public List<CustomVersion> CustomVersionContainer;

Exports

Map of object exports. UAssetAPI used to call these "categories."

public List<Export> Exports;

WorldTileInfo

Tile information used by WorldComposition. Defines properties necessary for tile positioning in the world.

public FWorldTileInfo WorldTileInfo;

MapStructTypeOverride

In MapProperties that have StructProperties as their keys or values, there is no universal, context-free way to determine the type of the struct.

To that end, this dictionary maps MapProperty names to the type of the structs within them (tuple of key struct type and value struct type) if they are not None-terminated property lists.

public Dictionary<string, Tuple<FString, FString>> MapStructTypeOverride;

ArrayStructTypeOverride

IN ENGINE VERSIONS BEFORE ObjectVersion.VER_UE4_INNER_ARRAY_TAG_INFO:

In ArrayProperties that have StructProperties as their keys or values, there is no universal, context-free way to determine the type of the struct. To that end, this dictionary maps ArrayProperty names to the type of the structs within them.

public Dictionary<string, FString> ArrayStructTypeOverride;

Properties

PackageFlags

The flags for this package.

public EPackageFlags PackageFlags { get; set; }

Property Value

EPackageFlags

HasUnversionedProperties

Whether or not this asset uses unversioned properties.

public bool HasUnversionedProperties { get; }

Property Value

Boolean

Methods

FixNameMapLookupIfNeeded()

internal void FixNameMapLookupIfNeeded()

GetNameMapIndexList()

Returns the name map as a read-only list of FStrings.

public IReadOnlyList<FString> GetNameMapIndexList()

Returns

IReadOnlyList<FString>
The name map as a read-only list of FStrings.

ClearNameIndexList()

Clears the name map. This method should be used with extreme caution, as it may break unparsed references to the name map.

public void ClearNameIndexList()

SetNameReference(Int32, FString)

Replaces a value in the name map at a particular index.

public void SetNameReference(int index, FString value)

Parameters

index Int32
The index to overwrite in the name map.

value FString
The value that will be replaced in the name map.

GetNameReference(Int32)

Gets a value in the name map at a particular index.

public FString GetNameReference(int index)

Parameters

index Int32
The index to return the value at.

Returns

FString
The value at the index provided.

GetNameReferenceWithoutZero(Int32)

Gets a value in the name map at a particular index, but with the index zero being treated as if it is not valid.

public FString GetNameReferenceWithoutZero(int index)

Parameters

index Int32
The index to return the value at.

Returns

FString
The value at the index provided.

ContainsNameReference(FString)

Checks whether or not the value exists in the name map.

public bool ContainsNameReference(FString search)

Parameters

search FString
The value to search the name map for.

Returns

Boolean
true if the value appears in the name map, otherwise false.

SearchNameReference(FString)

Searches the name map for a particular value.

public int SearchNameReference(FString search)

Parameters

search FString
The value to search the name map for.

Returns

Int32
The index at which the value appears in the name map.

Exceptions

NameMapOutOfRangeException
Thrown when the value provided does not appear in the name map.

AddNameReference(FString, Boolean)

Adds a new value to the name map.

public int AddNameReference(FString name, bool forceAddDuplicates)

Parameters

name FString
The value to add to the name map.

forceAddDuplicates Boolean
Whether or not to add a new entry if the value provided already exists in the name map.

Returns

Int32
The index of the new value in the name map. If the value already existed in the name map beforehand, that index will be returned instead.

Exceptions

ArgumentException
Thrown when forceAddDuplicates is false and the value provided is null or empty.

PathToStream(String)

Creates a MemoryStream from an asset path.

public MemoryStream PathToStream(string p)

Parameters

p String
The path to the input file.

Returns

MemoryStream
A new MemoryStream that stores the binary data of the input file.

PathToReader(String)

Creates a BinaryReader from an asset path.

public AssetBinaryReader PathToReader(string p)

Parameters

p String
The path to the input file.

Returns

AssetBinaryReader
A new BinaryReader that stores the binary data of the input file.

GetClassExport()

Searches for and returns this asset's ClassExport, if one exists.

public ClassExport GetClassExport()

Returns

ClassExport
The asset's ClassExport if one exists, otherwise null.

GetParentClass(FName&, FName&)

Finds the class path and export name of the SuperStruct of this asset, if it exists.

public void GetParentClass(FName& parentClassPath, FName& parentClassExportName)

Parameters

parentClassPath FName&
The class path of the SuperStruct of this asset, if it exists.

parentClassExportName FName&
The export name of the SuperStruct of this asset, if it exists.

GetParentClassExportName()

internal FName GetParentClassExportName()

Returns

FName

ResolveAncestries()

Resolves the ancestry of all properties present in this asset.

public void ResolveAncestries()

SetEngineVersion(EngineVersion)

Sets the version of the Unreal Engine to use in serialization.

public void SetEngineVersion(EngineVersion newVersion)

Parameters

newVersion EngineVersion
The new version of the Unreal Engine to use in serialization.

Exceptions

InvalidOperationException
Thrown when an invalid UE4Version is specified.

GetEngineVersion(ObjectVersion, ObjectVersionUE5, List<CustomVersion>)

public static EngineVersion GetEngineVersion(ObjectVersion objectVersion, ObjectVersionUE5 objectVersionUE5, List<CustomVersion> customVersionContainer)

Parameters

objectVersion ObjectVersion

objectVersionUE5 ObjectVersionUE5

customVersionContainer List<CustomVersion>

Returns

EngineVersion

GetEngineVersion()

Estimates the retail version of the Unreal Engine based on the object and custom versions.

public EngineVersion GetEngineVersion()

Returns

EngineVersion
The estimated retail version of the Unreal Engine.

GetCustomVersion(Guid)

Fetches the version of a custom version in this asset.

public int GetCustomVersion(Guid key)

Parameters

key Guid
The GUID of the custom version to retrieve.

Returns

Int32
The version of the retrieved custom version.

GetCustomVersion(String)

Fetches the version of a custom version in this asset.

public int GetCustomVersion(string friendlyName)

Parameters

friendlyName String
The friendly name of the custom version to retrieve.

Returns

Int32
The version of the retrieved custom version.

GetCustomVersion<T>()

Fetches a custom version's enum value based off of its type.

public T GetCustomVersion<T>()

Type Parameters

T
The enum type of the custom version to retrieve.

Returns

T
The enum value of the requested custom version.

Exceptions

ArgumentException
Thrown when T is not an enumerated type.

GuessCustomVersionFromTypeAndEngineVersion(EngineVersion, Type)

public static int GuessCustomVersionFromTypeAndEngineVersion(EngineVersion chosenVersion, Type typ)

Parameters

chosenVersion EngineVersion

typ Type

Returns

Int32

GetDefaultCustomVersionContainer(EngineVersion)

Fetches a list of all default custom versions for a specific Unreal version.

public static List<CustomVersion> GetDefaultCustomVersionContainer(EngineVersion chosenVersion)

Parameters

chosenVersion EngineVersion
The version of the engine to check against.

Returns

List<CustomVersion>
A list of all the default custom version values for the given engine version.

ConvertExportToChildExportAndRead(AssetBinaryReader, Int32)

protected void ConvertExportToChildExportAndRead(AssetBinaryReader reader, int i)

Parameters

reader AssetBinaryReader

i Int32

Read(AssetBinaryReader, Int32[], Int32[])

Reads an asset into memory.

public void Read(AssetBinaryReader reader, Int32[] manualSkips, Int32[] forceReads)

Parameters

reader AssetBinaryReader
The input reader.

manualSkips Int32[]
An array of export indexes to skip parsing. For most applications, this should be left blank.

forceReads Int32[]
An array of export indexes that must be read, overriding entries in the manualSkips parameter. For most applications, this should be left blank.

Exceptions

UnknownEngineVersionException
Thrown when this is an unversioned asset and is unspecified.

FormatException
Throw when the asset cannot be parsed correctly.

WriteData()

Serializes an asset from memory.

public MemoryStream WriteData()

Returns

MemoryStream
A stream that the asset has been serialized to.

Write(String)

Serializes and writes an asset to disk from memory.

public void Write(string outputPath)

Parameters

outputPath String
The path on disk to write the asset to.

Exceptions

UnknownEngineVersionException
Thrown when is unspecified.

UsmapBinaryReader

Namespace: UAssetAPI

Reads primitive data types from .usmap files.

public class UsmapBinaryReader : System.IO.BinaryReader, System.IDisposable

Inheritance Object → BinaryReader → UsmapBinaryReader
Implements IDisposable

Fields

File

public Usmap File;

Properties

BaseStream

public Stream BaseStream { get; }

Property Value

Stream

Constructors

UsmapBinaryReader(Stream, Usmap)

public UsmapBinaryReader(Stream stream, Usmap file)

Parameters

stream Stream

file Usmap

Methods

ReadInt16()

public short ReadInt16()

Returns

Int16

ReadUInt16()

public ushort ReadUInt16()

Returns

UInt16

ReadInt32()

public int ReadInt32()

Returns

Int32

ReadUInt32()

public uint ReadUInt32()

Returns

UInt32

ReadInt64()

public long ReadInt64()

Returns

Int64

ReadUInt64()

public ulong ReadUInt64()

Returns

UInt64

ReadSingle()

public float ReadSingle()

Returns

Single

ReadDouble()

public double ReadDouble()

Returns

Double

ReadString()

public string ReadString()

Returns

String

ReadString(Int32)

public string ReadString(int fixedLength)

Parameters

fixedLength Int32

Returns

String

ReadName()

public string ReadName()

Returns

String

FAnimPhysObjectVersion

Namespace: UAssetAPI.CustomVersions

Custom serialization version for changes made in Dev-AnimPhys stream

public enum FAnimPhysObjectVersion

Inheritance Object → ValueType → Enum → FAnimPhysObjectVersion
Implements IComparable, IFormattable, IConvertible

Fields

FAssetRegistryVersion

Namespace: UAssetAPI.CustomVersions

Version used for serializing asset registry caches, both runtime and editor

public enum FAssetRegistryVersion

Inheritance Object → ValueType → Enum → FAssetRegistryVersion
Implements IComparable, IFormattable, IConvertible

Fields

FCoreObjectVersion

Namespace: UAssetAPI.CustomVersions

Custom serialization version for changes made in Dev-Core stream.

public enum FCoreObjectVersion

Inheritance Object → ValueType → Enum → FCoreObjectVersion
Implements IComparable, IFormattable, IConvertible

Fields

FEditorObjectVersion

Namespace: UAssetAPI.CustomVersions

Custom serialization version for changes made in Dev-Editor stream.

public enum FEditorObjectVersion

Inheritance Object → ValueType → Enum → FEditorObjectVersion
Implements IComparable, IFormattable, IConvertible

Fields

FFortniteMainBranchObjectVersion

Namespace: UAssetAPI.CustomVersions

Custom serialization version for changes made in the //Fortnite/Main stream.

public enum FFortniteMainBranchObjectVersion

Inheritance Object → ValueType → Enum → FFortniteMainBranchObjectVersion
Implements IComparable, IFormattable, IConvertible

Fields

FFrameworkObjectVersion

Namespace: UAssetAPI.CustomVersions

Custom serialization version for changes made in Dev-Framework stream.

public enum FFrameworkObjectVersion

Inheritance Object → ValueType → Enum → FFrameworkObjectVersion
Implements IComparable, IFormattable, IConvertible

Fields

FReleaseObjectVersion

Namespace: UAssetAPI.CustomVersions

Custom serialization version for changes made in Release streams.

public enum FReleaseObjectVersion

Inheritance Object → ValueType → Enum → FReleaseObjectVersion
Implements IComparable, IFormattable, IConvertible

Fields

FSequencerObjectVersion

Namespace: UAssetAPI.CustomVersions

public enum FSequencerObjectVersion

Inheritance Object → ValueType → Enum → FSequencerObjectVersion
Implements IComparable, IFormattable, IConvertible

Fields

IntroducedAttribute

Namespace: UAssetAPI.CustomVersions

Represents the engine version at the time that a custom version was implemented.

public class IntroducedAttribute : System.Attribute

Inheritance Object → Attribute → IntroducedAttribute

Fields

IntroducedVersion

public EngineVersion IntroducedVersion;

Properties

TypeId

public object TypeId { get; }

Property Value

Object

Constructors

IntroducedAttribute(EngineVersion)

public IntroducedAttribute(EngineVersion introducedVersion)

Parameters

introducedVersion EngineVersion

ClassExport

Namespace: UAssetAPI.ExportTypes

Represents an object class.

public class ClassExport : StructExport, System.ICloneable

Inheritance Object → Export → NormalExport → FieldExport → StructExport → ClassExport
Implements ICloneable

Fields

FuncMap

Map of all functions by name contained in this class

public TMap<FName, FPackageIndex> FuncMap;

ClassFlags

Class flags; See EClassFlags for more information

public EClassFlags ClassFlags;

ClassWithin

The required type for the outer of instances of this class

public FPackageIndex ClassWithin;

ClassConfigName

Which Name.ini file to load Config variables out of

public FName ClassConfigName;

Interfaces

The list of interfaces which this class implements, along with the pointer property that is located at the offset of the interface's vtable. If the interface class isn't native, the property will be empty.

public SerializedInterfaceReference[] Interfaces;

ClassGeneratedBy

This is the blueprint that caused the generation of this class, or null if it is a native compiled-in class

public FPackageIndex ClassGeneratedBy;

bDeprecatedForceScriptOrder

Does this class use deprecated script order?

public bool bDeprecatedForceScriptOrder;

bCooked

Used to check if the class was cooked or not

public bool bCooked;

ClassDefaultObject

The class default object; used for delta serialization and object initialization

public FPackageIndex ClassDefaultObject;

SuperStruct

Struct this inherits from, may be null

public FPackageIndex SuperStruct;

Children

List of child fields

public FPackageIndex[] Children;

LoadedProperties

Properties serialized with this struct definition

public FProperty[] LoadedProperties;

ScriptBytecode

The bytecode instructions contained within this struct.

public KismetExpression[] ScriptBytecode;

ScriptBytecodeSize

Bytecode size in total in deserialized memory. Filled out in lieu of StructExport.ScriptBytecode if an error occurs during bytecode parsing.

public int ScriptBytecodeSize;

ScriptBytecodeRaw

Raw binary bytecode data. Filled out in lieu of StructExport.ScriptBytecode if an error occurs during bytecode parsing.

public Byte[] ScriptBytecodeRaw;

Field

public UField Field;

Data

public List<PropertyData> Data;

ObjectName

The name of the UObject represented by this resource.

public FName ObjectName;

ObjectFlags

The object flags for the UObject represented by this resource. Only flags that match the RF_Load combination mask will be loaded from disk and applied to the UObject.

public EObjectFlags ObjectFlags;

SerialSize

The number of bytes to serialize when saving/loading this export's UObject.

public long SerialSize;

SerialOffset

The location (into the FLinker's underlying file reader archive) of the beginning of the data for this export's UObject. Used for verification only.

public long SerialOffset;

bForcedExport

Was this export forced into the export table via OBJECTMARK_ForceTagExp?

public bool bForcedExport;

bNotForClient

Should this export not be loaded on clients?

public bool bNotForClient;

bNotForServer

Should this export not be loaded on servers?

public bool bNotForServer;

PackageGuid

If this object is a top level package (which must have been forced into the export table via OBJECTMARK_ForceTagExp), this is the GUID for the original package file. Deprecated

public Guid PackageGuid;

IsInheritedInstance

public bool IsInheritedInstance;

PackageFlags

If this export is a top-level package, this is the flags for the original package

public EPackageFlags PackageFlags;

bNotAlwaysLoadedForEditorGame

Should this export be always loaded in editor game?

public bool bNotAlwaysLoadedForEditorGame;

bIsAsset

Is this export an asset?

public bool bIsAsset;

GeneratePublicHash

public bool GeneratePublicHash;

SerializationBeforeSerializationDependencies

public List<FPackageIndex> SerializationBeforeSerializationDependencies;

CreateBeforeSerializationDependencies

public List<FPackageIndex> CreateBeforeSerializationDependencies;

SerializationBeforeCreateDependencies

public List<FPackageIndex> SerializationBeforeCreateDependencies;

CreateBeforeCreateDependencies

public List<FPackageIndex> CreateBeforeCreateDependencies;

Zen_OuterIndex

public FPackageObjectIndex Zen_OuterIndex;

Zen_ClassIndex

public FPackageObjectIndex Zen_ClassIndex;

Zen_SuperIndex

public FPackageObjectIndex Zen_SuperIndex;

Zen_TemplateIndex

public FPackageObjectIndex Zen_TemplateIndex;

PublicExportHash

PublicExportHash. Interpreted as a global import FPackageObjectIndex in UE4 assets.

public ulong PublicExportHash;

Padding

public Byte[] Padding;

Extras

Miscellaneous, unparsed export data, stored as a byte array.

public Byte[] Extras;

Asset

The asset that this export is parsed with.

public UnrealPackage Asset;

Properties

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

OuterIndex

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage

public FPackageIndex OuterIndex { get; set; }

Property Value

FPackageIndex

ClassIndex

Location of this export's class (import/other export). 0 = this export is a UClass

public FPackageIndex ClassIndex { get; set; }

Property Value

FPackageIndex

SuperIndex

Location of this export's parent class (import/other export). 0 = this export is not derived from UStruct

public FPackageIndex SuperIndex { get; set; }

Property Value

FPackageIndex

TemplateIndex

Location of this export's template (import/other export). 0 = there is some problem

public FPackageIndex TemplateIndex { get; set; }

Property Value

FPackageIndex

Constructors

ClassExport(Export)

public ClassExport(Export super)

Parameters

super Export

ClassExport(UAsset, Byte[])

public ClassExport(UAsset asset, Byte[] extras)

Parameters

asset UAsset

extras Byte[]

ClassExport()

public ClassExport()

Methods

Read(AssetBinaryReader, Int32)

public void Read(AssetBinaryReader reader, int nextStarting)

Parameters

reader AssetBinaryReader

nextStarting Int32

Write(AssetBinaryWriter)

public void Write(AssetBinaryWriter writer)

Parameters

writer AssetBinaryWriter

DataTableExport

Namespace: UAssetAPI.ExportTypes

Export for an imported spreadsheet table. See UDataTable.

public class DataTableExport : NormalExport, System.ICloneable

Inheritance Object → Export → NormalExport → DataTableExport
Implements ICloneable

Fields

Table

public UDataTable Table;

Data

public List<PropertyData> Data;

ObjectName

The name of the UObject represented by this resource.

public FName ObjectName;

ObjectFlags

The object flags for the UObject represented by this resource. Only flags that match the RF_Load combination mask will be loaded from disk and applied to the UObject.

public EObjectFlags ObjectFlags;

SerialSize

The number of bytes to serialize when saving/loading this export's UObject.

public long SerialSize;

SerialOffset

The location (into the FLinker's underlying file reader archive) of the beginning of the data for this export's UObject. Used for verification only.

public long SerialOffset;

bForcedExport

Was this export forced into the export table via OBJECTMARK_ForceTagExp?

public bool bForcedExport;

bNotForClient

Should this export not be loaded on clients?

public bool bNotForClient;

bNotForServer

Should this export not be loaded on servers?

public bool bNotForServer;

PackageGuid

If this object is a top level package (which must have been forced into the export table via OBJECTMARK_ForceTagExp), this is the GUID for the original package file. Deprecated

public Guid PackageGuid;

IsInheritedInstance

public bool IsInheritedInstance;

PackageFlags

If this export is a top-level package, this is the flags for the original package

public EPackageFlags PackageFlags;

bNotAlwaysLoadedForEditorGame

Should this export be always loaded in editor game?

public bool bNotAlwaysLoadedForEditorGame;

bIsAsset

Is this export an asset?

public bool bIsAsset;

GeneratePublicHash

public bool GeneratePublicHash;

SerializationBeforeSerializationDependencies

public List<FPackageIndex> SerializationBeforeSerializationDependencies;

CreateBeforeSerializationDependencies

public List<FPackageIndex> CreateBeforeSerializationDependencies;

SerializationBeforeCreateDependencies

public List<FPackageIndex> SerializationBeforeCreateDependencies;

CreateBeforeCreateDependencies

public List<FPackageIndex> CreateBeforeCreateDependencies;

Zen_OuterIndex

public FPackageObjectIndex Zen_OuterIndex;

Zen_ClassIndex

public FPackageObjectIndex Zen_ClassIndex;

Zen_SuperIndex

public FPackageObjectIndex Zen_SuperIndex;

Zen_TemplateIndex

public FPackageObjectIndex Zen_TemplateIndex;

PublicExportHash

PublicExportHash. Interpreted as a global import FPackageObjectIndex in UE4 assets.

public ulong PublicExportHash;

Padding

public Byte[] Padding;

Extras

Miscellaneous, unparsed export data, stored as a byte array.

public Byte[] Extras;

Asset

The asset that this export is parsed with.

public UnrealPackage Asset;

Properties

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

OuterIndex

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage

public FPackageIndex OuterIndex { get; set; }

Property Value

FPackageIndex

ClassIndex

Location of this export's class (import/other export). 0 = this export is a UClass

public FPackageIndex ClassIndex { get; set; }

Property Value

FPackageIndex

SuperIndex

Location of this export's parent class (import/other export). 0 = this export is not derived from UStruct

public FPackageIndex SuperIndex { get; set; }

Property Value

FPackageIndex

TemplateIndex

Location of this export's template (import/other export). 0 = there is some problem

public FPackageIndex TemplateIndex { get; set; }

Property Value

FPackageIndex

Constructors

DataTableExport(Export)

public DataTableExport(Export super)

Parameters

super Export

DataTableExport(UDataTable, UAsset, Byte[])

public DataTableExport(UDataTable data, UAsset asset, Byte[] extras)

Parameters

data UDataTable

asset UAsset

extras Byte[]

DataTableExport()

public DataTableExport()

Methods

Read(AssetBinaryReader, Int32)

public void Read(AssetBinaryReader reader, int nextStarting)

Parameters

reader AssetBinaryReader

nextStarting Int32

ResolveAncestries(UnrealPackage, AncestryInfo)

public void ResolveAncestries(UnrealPackage asset, AncestryInfo ancestrySoFar)

Parameters

asset UnrealPackage

ancestrySoFar AncestryInfo

Write(AssetBinaryWriter)

public void Write(AssetBinaryWriter writer)

Parameters

writer AssetBinaryWriter

ECppForm

Namespace: UAssetAPI.ExportTypes

How this enum is declared in C++. Affects the internal naming of enum values.

public enum ECppForm

Inheritance Object → ValueType → Enum → ECppForm
Implements IComparable, IFormattable, IConvertible

Fields

EExportFilterFlags

Namespace: UAssetAPI.ExportTypes

Enum used to determine whether an export should be loaded or not on the client/server. Not actually a bitflag.

public enum EExportFilterFlags

Inheritance Object → ValueType → Enum → EExportFilterFlags
Implements IComparable, IFormattable, IConvertible

Fields

EnumExport

Namespace: UAssetAPI.ExportTypes

Export data for an enumeration. See UEnum.

public class EnumExport : NormalExport, System.ICloneable

Inheritance Object → Export → NormalExport → EnumExport
Implements ICloneable

Fields

Enum

The enum that is stored in this export.

public UEnum Enum;

Data

public List<PropertyData> Data;

ObjectName

The name of the UObject represented by this resource.

public FName ObjectName;

ObjectFlags

The object flags for the UObject represented by this resource. Only flags that match the RF_Load combination mask will be loaded from disk and applied to the UObject.

public EObjectFlags ObjectFlags;

SerialSize

The number of bytes to serialize when saving/loading this export's UObject.

public long SerialSize;

SerialOffset

The location (into the FLinker's underlying file reader archive) of the beginning of the data for this export's UObject. Used for verification only.

public long SerialOffset;

bForcedExport

Was this export forced into the export table via OBJECTMARK_ForceTagExp?

public bool bForcedExport;

bNotForClient

Should this export not be loaded on clients?

public bool bNotForClient;

bNotForServer

Should this export not be loaded on servers?

public bool bNotForServer;

PackageGuid

If this object is a top level package (which must have been forced into the export table via OBJECTMARK_ForceTagExp), this is the GUID for the original package file. Deprecated

public Guid PackageGuid;

IsInheritedInstance

public bool IsInheritedInstance;

PackageFlags

If this export is a top-level package, this is the flags for the original package

public EPackageFlags PackageFlags;

bNotAlwaysLoadedForEditorGame

Should this export be always loaded in editor game?

public bool bNotAlwaysLoadedForEditorGame;

bIsAsset

Is this export an asset?

public bool bIsAsset;

GeneratePublicHash

public bool GeneratePublicHash;

SerializationBeforeSerializationDependencies

public List<FPackageIndex> SerializationBeforeSerializationDependencies;

CreateBeforeSerializationDependencies

public List<FPackageIndex> CreateBeforeSerializationDependencies;

SerializationBeforeCreateDependencies

public List<FPackageIndex> SerializationBeforeCreateDependencies;

CreateBeforeCreateDependencies

public List<FPackageIndex> CreateBeforeCreateDependencies;

Zen_OuterIndex

public FPackageObjectIndex Zen_OuterIndex;

Zen_ClassIndex

public FPackageObjectIndex Zen_ClassIndex;

Zen_SuperIndex

public FPackageObjectIndex Zen_SuperIndex;

Zen_TemplateIndex

public FPackageObjectIndex Zen_TemplateIndex;

PublicExportHash

PublicExportHash. Interpreted as a global import FPackageObjectIndex in UE4 assets.

public ulong PublicExportHash;

Padding

public Byte[] Padding;

Extras

Miscellaneous, unparsed export data, stored as a byte array.

public Byte[] Extras;

Asset

The asset that this export is parsed with.

public UnrealPackage Asset;

Properties

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

OuterIndex

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage

public FPackageIndex OuterIndex { get; set; }

Property Value

FPackageIndex

ClassIndex

Location of this export's class (import/other export). 0 = this export is a UClass

public FPackageIndex ClassIndex { get; set; }

Property Value

FPackageIndex

SuperIndex

Location of this export's parent class (import/other export). 0 = this export is not derived from UStruct

public FPackageIndex SuperIndex { get; set; }

Property Value

FPackageIndex

TemplateIndex

Location of this export's template (import/other export). 0 = there is some problem

public FPackageIndex TemplateIndex { get; set; }

Property Value

FPackageIndex

Constructors

EnumExport(Export)

public EnumExport(Export super)

Parameters

super Export

EnumExport(UAsset, Byte[])

public EnumExport(UAsset asset, Byte[] extras)

Parameters

asset UAsset

extras Byte[]

EnumExport()

public EnumExport()

Methods

Read(AssetBinaryReader, Int32)

public void Read(AssetBinaryReader reader, int nextStarting)

Parameters

reader AssetBinaryReader

nextStarting Int32

Write(AssetBinaryWriter)

public void Write(AssetBinaryWriter writer)

Parameters

writer AssetBinaryWriter

Export

Namespace: UAssetAPI.ExportTypes

UObject resource type for objects that are contained within this package and can be referenced by other packages.

public class Export : System.ICloneable

Inheritance Object → Export
Implements ICloneable

Fields

ObjectName

The name of the UObject represented by this resource.

public FName ObjectName;

ObjectFlags

The object flags for the UObject represented by this resource. Only flags that match the RF_Load combination mask will be loaded from disk and applied to the UObject.

public EObjectFlags ObjectFlags;

SerialSize

The number of bytes to serialize when saving/loading this export's UObject.

public long SerialSize;

SerialOffset

The location (into the FLinker's underlying file reader archive) of the beginning of the data for this export's UObject. Used for verification only.

public long SerialOffset;

bForcedExport

Was this export forced into the export table via OBJECTMARK_ForceTagExp?

public bool bForcedExport;

bNotForClient

Should this export not be loaded on clients?

public bool bNotForClient;

bNotForServer

Should this export not be loaded on servers?

public bool bNotForServer;

PackageGuid

If this object is a top level package (which must have been forced into the export table via OBJECTMARK_ForceTagExp), this is the GUID for the original package file. Deprecated

public Guid PackageGuid;

IsInheritedInstance

public bool IsInheritedInstance;

PackageFlags

If this export is a top-level package, this is the flags for the original package

public EPackageFlags PackageFlags;

bNotAlwaysLoadedForEditorGame

Should this export be always loaded in editor game?

public bool bNotAlwaysLoadedForEditorGame;

bIsAsset

Is this export an asset?

public bool bIsAsset;

GeneratePublicHash

public bool GeneratePublicHash;

SerializationBeforeSerializationDependencies

public List<FPackageIndex> SerializationBeforeSerializationDependencies;

CreateBeforeSerializationDependencies

public List<FPackageIndex> CreateBeforeSerializationDependencies;

SerializationBeforeCreateDependencies

public List<FPackageIndex> SerializationBeforeCreateDependencies;

CreateBeforeCreateDependencies

public List<FPackageIndex> CreateBeforeCreateDependencies;

Zen_OuterIndex

public FPackageObjectIndex Zen_OuterIndex;

Zen_ClassIndex

public FPackageObjectIndex Zen_ClassIndex;

Zen_SuperIndex

public FPackageObjectIndex Zen_SuperIndex;

Zen_TemplateIndex

public FPackageObjectIndex Zen_TemplateIndex;

PublicExportHash

PublicExportHash. Interpreted as a global import FPackageObjectIndex in UE4 assets.

public ulong PublicExportHash;

Padding

public Byte[] Padding;

Extras

Miscellaneous, unparsed export data, stored as a byte array.

public Byte[] Extras;

Asset

The asset that this export is parsed with.

public UnrealPackage Asset;

Properties

OuterIndex

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage

public FPackageIndex OuterIndex { get; set; }

Property Value

FPackageIndex

ClassIndex

Location of this export's class (import/other export). 0 = this export is a UClass

public FPackageIndex ClassIndex { get; set; }

Property Value

FPackageIndex

SuperIndex

Location of this export's parent class (import/other export). 0 = this export is not derived from UStruct

public FPackageIndex SuperIndex { get; set; }

Property Value

FPackageIndex

TemplateIndex

Location of this export's template (import/other export). 0 = there is some problem

public FPackageIndex TemplateIndex { get; set; }

Property Value

FPackageIndex

Constructors

Export(UnrealPackage, Byte[])

public Export(UnrealPackage asset, Byte[] extras)

Parameters

asset UnrealPackage

extras Byte[]

Export()

public Export()

Methods

ShouldSerializeOuterIndex()

public bool ShouldSerializeOuterIndex()

Returns

Boolean

ShouldSerializeClassIndex()

public bool ShouldSerializeClassIndex()

Returns

Boolean

ShouldSerializeSuperIndex()

public bool ShouldSerializeSuperIndex()

Returns

Boolean

ShouldSerializeTemplateIndex()

public bool ShouldSerializeTemplateIndex()

Returns

Boolean

ShouldSerializeZen_OuterIndex()

public bool ShouldSerializeZen_OuterIndex()

Returns

Boolean

ShouldSerializeZen_ClassIndex()

public bool ShouldSerializeZen_ClassIndex()

Returns

Boolean

ShouldSerializeZen_SuperIndex()

public bool ShouldSerializeZen_SuperIndex()

Returns

Boolean

ShouldSerializeZen_TemplateIndex()

public bool ShouldSerializeZen_TemplateIndex()

Returns

Boolean

Read(AssetBinaryReader, Int32)

public void Read(AssetBinaryReader reader, int nextStarting)

Parameters

reader AssetBinaryReader

nextStarting Int32

ResolveAncestries(UnrealPackage, AncestryInfo)

Resolves the ancestry of all child properties of this export.

public void ResolveAncestries(UnrealPackage asset, AncestryInfo ancestrySoFar)

Parameters

asset UnrealPackage

ancestrySoFar AncestryInfo

Write(AssetBinaryWriter)

public void Write(AssetBinaryWriter writer)

Parameters

writer AssetBinaryWriter

ReadExportMapEntry(AssetBinaryReader)

public void ReadExportMapEntry(AssetBinaryReader reader)

Parameters

reader AssetBinaryReader

GetExportMapEntrySize(UnrealPackage)

public static long GetExportMapEntrySize(UnrealPackage asset)

Parameters

asset UnrealPackage

Returns

Int64

WriteExportMapEntry(AssetBinaryWriter)

public void WriteExportMapEntry(AssetBinaryWriter writer)

Parameters

writer AssetBinaryWriter

GetAllObjectExportFields(UnrealPackage)

public static MemberInfo[] GetAllObjectExportFields(UnrealPackage asset)

Parameters

asset UnrealPackage

Returns

MemberInfo[]

GetAllFieldNames(UnrealPackage)

public static String[] GetAllFieldNames(UnrealPackage asset)

Parameters

asset UnrealPackage

Returns

String[]

GetExportClassType()

public FName GetExportClassType()

Returns

FName

GetClassTypeForAncestry(UnrealPackage)

public FName GetClassTypeForAncestry(UnrealPackage asset)

Parameters

asset UnrealPackage

Returns

FName

GetClassTypeForAncestry(FPackageIndex, UnrealPackage)

public static FName GetClassTypeForAncestry(FPackageIndex classIndex, UnrealPackage asset)

Parameters

classIndex FPackageIndex

asset UnrealPackage

Returns

FName

ToString()

public string ToString()

Returns

String

Clone()

public object Clone()

Returns

Object

ConvertToChildExport<T>()

Creates a child export instance with the same export details as the current export.

public T ConvertToChildExport<T>()

Type Parameters

T
The type of child export to create.

Returns

T
An instance of the child export type provided with the export details copied over.

FieldExport

Namespace: UAssetAPI.ExportTypes

Export data for a UField.

public class FieldExport : NormalExport, System.ICloneable

Inheritance Object → Export → NormalExport → FieldExport
Implements ICloneable

Fields

Field

public UField Field;

Data

public List<PropertyData> Data;

ObjectName

The name of the UObject represented by this resource.

public FName ObjectName;

ObjectFlags

The object flags for the UObject represented by this resource. Only flags that match the RF_Load combination mask will be loaded from disk and applied to the UObject.

public EObjectFlags ObjectFlags;

SerialSize

The number of bytes to serialize when saving/loading this export's UObject.

public long SerialSize;

SerialOffset

The location (into the FLinker's underlying file reader archive) of the beginning of the data for this export's UObject. Used for verification only.

public long SerialOffset;

bForcedExport

Was this export forced into the export table via OBJECTMARK_ForceTagExp?

public bool bForcedExport;

bNotForClient

Should this export not be loaded on clients?

public bool bNotForClient;

bNotForServer

Should this export not be loaded on servers?

public bool bNotForServer;

PackageGuid

If this object is a top level package (which must have been forced into the export table via OBJECTMARK_ForceTagExp), this is the GUID for the original package file. Deprecated

public Guid PackageGuid;

IsInheritedInstance

public bool IsInheritedInstance;

PackageFlags

If this export is a top-level package, this is the flags for the original package

public EPackageFlags PackageFlags;

bNotAlwaysLoadedForEditorGame

Should this export be always loaded in editor game?

public bool bNotAlwaysLoadedForEditorGame;

bIsAsset

Is this export an asset?

public bool bIsAsset;

GeneratePublicHash

public bool GeneratePublicHash;

SerializationBeforeSerializationDependencies

public List<FPackageIndex> SerializationBeforeSerializationDependencies;

CreateBeforeSerializationDependencies

public List<FPackageIndex> CreateBeforeSerializationDependencies;

SerializationBeforeCreateDependencies

public List<FPackageIndex> SerializationBeforeCreateDependencies;

CreateBeforeCreateDependencies

public List<FPackageIndex> CreateBeforeCreateDependencies;

Zen_OuterIndex

public FPackageObjectIndex Zen_OuterIndex;

Zen_ClassIndex

public FPackageObjectIndex Zen_ClassIndex;

Zen_SuperIndex

public FPackageObjectIndex Zen_SuperIndex;

Zen_TemplateIndex

public FPackageObjectIndex Zen_TemplateIndex;

PublicExportHash

PublicExportHash. Interpreted as a global import FPackageObjectIndex in UE4 assets.

public ulong PublicExportHash;

Padding

public Byte[] Padding;

Extras

Miscellaneous, unparsed export data, stored as a byte array.

public Byte[] Extras;

Asset

The asset that this export is parsed with.

public UnrealPackage Asset;

Properties

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

Item

public PropertyData Item { get; set; }

Property Value

PropertyData

OuterIndex

Location of the resource for this resource's Outer (import/other export). 0 = this resource is a top-level UPackage

public FPackageIndex OuterIndex { get; set; }

Property Value

FPackageIndex

ClassIndex

Location of this export's class (import/other export). 0 = this export is a UClass

public FPackageIndex ClassIndex { get; set; }

Property Value

FPackageIndex

SuperIndex

Location of this export's parent class (import/other export). 0 = this export is not derived from UStruct

public FPackageIndex SuperIndex { get; set; }

Property Value

FPackageIndex

TemplateIndex

Location of this export's template (import/other export). 0 = there is some problem

public FPackageIndex TemplateIndex { get; set; }

Property Value

FPackageIndex

Constructors

FieldExport(Export)

public FieldExport(Export super)

Parameters

super Export

FieldExport(UAsset, Byte[])

public FieldExport(UAsset asset, Byte[] extras)

Parameters

asset UAsset

extras Byte[]

FieldExport()

public FieldExport()

Methods

Read(AssetBinaryReader, Int32)

public void Read(AssetBinaryReader reader, int nextStarting)

Parameters

reader AssetBinaryReader

nextStarting Int32

Write(AssetBinaryWriter)

public void Write(AssetBinaryWriter writer)

Parameters

writer AssetBinaryWriter

FStringTable

Namespace: UAssetAPI.ExportTypes

A string table. Holds Key->SourceString pairs of text.

public class FStringTable : UAssetAPI.UnrealTypes.TMap`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], UAssetAPI.UnrealTypes.IOrderedDictionary`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.IDictionary`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.ICollection`1[[System.Collections.Generic.KeyValuePair`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.Generic.IEnumerable`1[[System.Collections.Generic.KeyValuePair`2[[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null],[UAssetAPI.UnrealTypes.FString, UAssetAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.IEnumerable, System.Collections.Specialized.IOrderedDictionary, System.Collections.IDictionary, System.Collections.ICollection

Inheritance Object → TMap<FString, FString> → FStringTable
Implements IOrderedDictionary<FString, FString>, IDictionary<FString, FString>, ICollection<KeyValuePair<FString, FString>>, IEnumerable<KeyValuePair<FString, FString>>, IEnumerable, IOrderedDictionary, IDictionary, ICollection

Fields

TableNamespace

public FString TableNamespace;

Properties

Item

public FString Item { get; set; }

Property Value

FString

Item

public FString Item { get; set; }

Property Value

FString

Count

Gets the number of items in the dictionary

public int Count { get; }

Property Value

Int32

Keys

Gets all the keys in the ordered dictionary in their proper order.

public ICollection<FString> Keys { get; }

Property Value

ICollection<FString>

Values

Gets all the values in the ordered dictionary in their proper order.

public ICollection<FString> Values { get; }

Property Value

ICollection<FString>

Comparer

Gets the key comparer for this dictionary

public IEqualityComparer<FString> Comparer { get; }

Property Value

IEqualityComparer<FString>

Constructors

FStringTable(FString)

public FStringTable(FString tableNamespace)

Parameters

tableNamespace FString

FStringTable()

public FStringTable()

FunctionExport

Namespace: UAssetAPI.ExportTypes

Export data for a blueprint function.

public class FunctionExport : StructExport, System.ICloneable

Inheritance Object → Export → NormalExport → FieldExport → StructExport → FunctionExport
Implements ICloneable

Fields

FunctionFlags

public EFunctionFlags FunctionFlags;

SuperStruct

Struct this inherits from, may be null

public FPackageIndex SuperStruct;

Children

List of child fields

public FPackageIndex[] Children;

LoadedProperties

Properties serialized with this struct definition

public FProperty[] LoadedProperties;

ScriptBytecode

The bytecode instructions contained within this struct.

public KismetExpression[] ScriptBytecode;

ScriptBytecodeSize

Bytecode size in total in deserialized memory. Filled out in lieu of StructExport.ScriptBytecode if an error occurs during bytecode parsing.

public int ScriptBytecodeSize;

ScriptBytecodeRaw

Raw binary bytecode data. Filled out in lieu of StructExport.ScriptBytecode if an error occurs during bytecode parsing.

public Byte[] ScriptBytecodeRaw;

Field

public UField Field;

Data

public List<PropertyData> Data;

ObjectName

The name of the UObject represented by this resource.

public FName ObjectName;

ObjectFlags

The object flags for the UObject represented by this resource. Only flags that match the RF_Load combination mask will be loaded from disk and applied to the UObject.

public EObjectFlags ObjectFlags;

SerialSize

The number of bytes to serialize when saving/loading this export's UObject.

public long SerialSize;

SerialOffset

The location (into the FLinker's underlying file reader archive) of the beginning of the data for this export's UObject. Used for verification only.

public long SerialOffset;

bForcedExport

Was this export forced into the export table via OBJECTMARK_ForceTagExp?

public bool bForcedExport;

bNotForClient

Should this export not be loaded on clients?

public bool bNotForClient;

bNotForServer

Should this export not be loaded on servers?

public bool bNotForServer;

PackageGuid

If this object is a top level package (which must have been forced into the export table via OBJECTMARK_ForceTagExp), this is the GUID for the original package file. Deprecated

public Guid PackageGuid;

IsInheritedInstance

public bool IsInheritedInstance;

PackageFlags

If this export is a top-level package, this is the flags for the original package

public EPackageFlags PackageFlags;

bNotAlwaysLoadedForEditorGame

Should this export be always loaded in editor game?

public bool bNotAlwaysLoadedForEditorGame;

bIsAsset

Is this export an asset?

public bool bIsAsset;

GeneratePublicHash

public bool GeneratePublicHash;

SerializationBeforeSerializationDependencies

public List<FPackageIndex> SerializationBeforeSerializationDependencies;

CreateBeforeSerializationDependencies

public List<FPackageIndex> CreateBeforeSerializationDependencies;

SerializationBeforeCreateDependencies

public List<FPackageIndex> SerializationBeforeCreateDependencies;

CreateBeforeCreateDependencies

public List<FPackageIndex> CreateBeforeCreateDependencies;

Zen_OuterIndex

public FPackageObjectIndex Zen_OuterIndex;

Zen_ClassIndex

public FPackageObjectIndex Zen_ClassIndex;

Zen_SuperIndex

public FPackageObjectIndex Zen_SuperIndex;

Zen_TemplateIndex

public FPackageObjectIndex Zen_TemplateIndex;

PublicExportHash

PublicExportHash. Interpreted as a global import FPackageObjectIndex in UE4 assets.

public ulong PublicExportHash;

Padding

public Byte[] Padding;

Extras

Miscellaneous, unparsed export data, stored as a byte array.

public Byte[] Extras;

Asset