SCRIPTING API / Assets and attributes / AssetGuid

AssetGuid

Persistent asset id (the asset's GUID, the same text the engine writes in asset metadata). Session asset handles change between runs; an AssetGuid does not. The engine resolves it to the loaded asset.

Kindstruct

NamespaceKroys.EngineScripting

Members6

SourceAssetGuid.cs

DECLARATION

Declaration

Namespace Kroys.EngineScripting.

Declaration

public readonly struct AssetGuid : IEquatable<AssetGuid>

REFERENCE

Members

Constructors

#public AssetGuid(ulong high, ulong low)

Creates a GUID from its two 64-bit halves.

constructor

Properties

#public ulong High { get; }

The high 64 bits of the GUID.

property

#public ulong Low { get; }

The low 64 bits of the GUID.

property

#public bool IsValid { get; }

False for the empty GUID.

property

Methods

#public static bool TryParse(string? text, out AssetGuid guid)

Parses "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" (dashes optional), the engine's GUID text.

methodstatic

#public static AssetGuid Parse(string text)

Parses the engine's GUID text; throws FormatException when it is not one.

methodstatic

Signatures

public AssetGuid(ulong high, ulong low)
public ulong High { get; }
public ulong Low { get; }
public bool IsValid { get; }
public static bool TryParse(string? text, out AssetGuid guid)
public static AssetGuid Parse(string text)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.