IOGlobalData

Namespace: UAssetAPI.IO

Global data exported from a game's global IO store container.

public class IOGlobalData : INameMap

Inheritance ObjectIOGlobalData
Implements INameMap

Fields

ScriptObjectEntries

public FScriptObjectEntry[] ScriptObjectEntries;

ScriptObjectEntriesMap

public Dictionary<FPackageObjectIndex, FScriptObjectEntry> ScriptObjectEntriesMap;

Constructors

IOGlobalData(IOStoreContainer, EngineVersion)

public IOGlobalData(IOStoreContainer container, EngineVersion engineVersion)

Parameters

container IOStoreContainer

engineVersion EngineVersion

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.

CanCreateDummies()

Whether or not we can create dummies in this name map. If false, attempting to define a dummy will append to the name map instead.

public bool CanCreateDummies()

Returns

Boolean
A boolean.