Class AssetBuildManifest

Namespace

Stride.Core.Assets

Assembly

Stride.Core.Assets.dll

Build-generated manifest (.sdbuild in obj/) describing what the asset compiler needs from a project. All paths are relative to the manifest file location.

[DataContract("AssetBuildManifest")]
public sealed class AssetBuildManifest

Inheritance

object

AssetBuildManifest

Extension Methods

UnsafeUtilities.As<T>(object?)

Fields

CurrentVersion

public const int CurrentVersion = 1

Field Value

int

FileExtension

public const string FileExtension = ".sdbuild"

Field Value

string

Properties

AssetNamespace

Asset URL namespace declaration: "true" = the package name, any other value = that name. Absent = bare URLs.

public string? AssetNamespace { get; set; }

Property Value

string

AssetNamespaceUsings

Namespaces this project brings into scope: their assets resolve by bare URL (using semantics).

public List<string> AssetNamespaceUsings { get; }

Property Value

List<string>

CompanionManifests

Manifests of the Assets companion projects an executable built on behalf of the projects it references (an in-solution plugin's companions, which the game does not reference).

public List<UFile> CompanionManifests { get; }

Property Value

List<UFile>

CompanionPackages

Companions the project declares (StrideCompanionProject and StrideCompanionPackage items).

public List<AssetBuildManifestCompanion> CompanionPackages { get; }

Property Value

List<AssetBuildManifestCompanion>

HostAssemblies

Host-loadable assemblies whose types appear in assets; the asset compiler loads exactly these.

[DataAlias("AssetAssemblies")]
public List<UFile> HostAssemblies { get; }

Property Value

List<UFile>

NuGetLockFile

The NuGet lock file (project.assets.json); source of the package dependency closure for this TargetFramework.

public UFile? NuGetLockFile { get; set; }

Property Value

UFile

PackageFile

The authored package file (.sdpkg); loaded when it exists, otherwise implicit defaults apply.

public UFile? PackageFile { get; set; }

Property Value

UFile

PackageKind

What the project's package carries (StridePackageKind); absent for a runtime package.

public PackageKind? PackageKind { get; set; }

Property Value

PackageKind?

PackageName

Package identity (PackageId or AssemblyName) and version, used to name the package and its bundle.

public string? PackageName { get; set; }

Property Value

string

PackageToolkit

The UI toolkit an Editor package's views are written for (StrideEditorToolkit); absent for a neutral one.

public string? PackageToolkit { get; set; }

Property Value

string

PackageVersion

public string? PackageVersion { get; set; }

Property Value

string

ProjectAssets

Project-asset files (e.g. .sdsl, .sdfx) declared as project items.

public List<AssetBuildManifestItem> ProjectAssets { get; }

Property Value

List<AssetBuildManifestItem>

ProjectFile

The project this manifest was generated from.

public UFile? ProjectFile { get; set; }

Property Value

UFile

ReferencedManifests

Manifests of referenced projects.

public List<UFile> ReferencedManifests { get; }

Property Value

List<UFile>

RootNamespace

public string? RootNamespace { get; set; }

Property Value

string

TargetFramework

public string? TargetFramework { get; set; }

Property Value

string

Version

public int Version { get; set; }

Property Value

int

Methods

GetAuthoredPackagePath(string)

Gets PackageFile resolved, when declared.

public string? GetAuthoredPackagePath(string manifestFile)

Parameters

manifestFile string

Returns

string

GetProjectPackagePath(string)

Gets the sdpkg next to ProjectFile, the package the editor pairs the project with.

public string? GetProjectPackagePath(string manifestFile)

Parameters

manifestFile string

Returns

string

ResolvePath(string, UFile)

Resolves a manifest-relative path against the manifest's location.

public static string ResolvePath(string manifestFile, UFile path)

Parameters

manifestFile string

path UFile

Returns

string