Table of Contents

Namespace Stride.Core.Assets

Classes

Asset

Base class for Asset.

AssetAliasAttribute

Associates a type name used in YAML content.

AssetAssembly

A host-loadable asset assembly declared in a packed sdpkg: the package-relative path to the dll plus the TargetFramework it was built for. A multi-targeted package declares one entry per host-compatible TFM so a consumer loads the build matching its asset compiler's runtime. TargetFramework is null for legacy single-TFM packages (load unconditionally).

AssetBuildManifest

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

AssetBuildManifestItem

A project-asset file entry; Link is relative to the project directory.

AssetCloner

Allows to clone an asset or values stored in an asset.

AssetCollectionItemIdHelper
AssetComposite

Base class for an asset that supports inheritance by composition.

AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>

A class containing the information of a hierarchy of asset parts contained in an AssetCompositeHierarchy<TAssetPartDesign, TAssetPart>.

AssetCompositeHierarchyExtensions

Extension methods for AssetCompositeHierarchy<TAssetPartDesign, TAssetPart> and AssetCompositeHierarchyData<TAssetPartDesign, TAssetPart>

AssetCompositeHierarchy<TAssetPartDesign, TAssetPart>
AssetContentTypeAttribute

Describes which runtime-type, loadable through the ContentManager, corresponds to the associated asset type.

AssetDescriptionAttribute

Associates meta-information to a particular Asset.

AssetException

An AssetException.

AssetFactory<T>

A base implementation of the IAssetFactory<T> interface.

AssetFileSerializer

Main entry point for serializing/deserializing Asset.

AssetFolder

A location relative to a package from where assets will be loaded

AssetFolderCollection

A collection of AssetFolder

AssetFormatVersionAttribute

Describes what format version this asset currently uses, for asset upgrading.

AssetHash

Helper to compute a stable hash from an asset including all meta informations (ids, overrides).

AssetImporterBase
AssetImporterParameters

Parameters used by Import(UFile, AssetImporterParameters)

AssetItem

An asset item part of a Package accessible through Assets.

AssetItemExtensions
AssetLoadResult<T>
AssetMigration

Helper for migrating asset to newer versions.

AssetMigrationContext

Context used by IAssetUpgrader.

AssetPartCollectionSerializer<TAssetPartDesign, TAssetPart>
AssetPartCollection<TAssetPartDesign, TAssetPart>
AssetReference

An asset reference.

AssetReferenceDataSerializer

Serializer for AssetReference.

AssetReferenceExtensions

Extension methods for AssetReference

AssetRegistry

A registry for various content associated with assets.

AssetSelector

An asset selector

AssetTracker

Base class for tracking assets and executing an action on each change.

AssetUpgraderAttribute

Describes which upgrader type to use to upgrade an asset, depending on this current version number.

AssetUpgraderBase
AssetUpgraderCollection
AssetWithSource

An asset that references a source file used during the compilation of the asset.

BasePart
BasePartDataSerializer
Bundle

Description of an asset bundle.

BundleCollection

A collection of bundles.

CodeUpgradeRunner

Hook for the Roslyn-based code-upgrade runner. The runner needs Roslyn (workspaces) and so lives in a Roslyn-capable layer that registers itself here at module init; Instance is null when no runner is available (e.g. headless tooling without the editor assembly), in which case source-code migration is silently skipped.

CollectionIdGenerator

A visitor that will generate a CollectionItemIdentifiers collection for each collection or dictionary of the visited object, and attach it to the related collection.

DefaultAssetFactory<T>

An implementation of the AssetFactory<T> class that uses the default public parameterless constructor of the associated asset type.

Dependency
DependencyRange
DirectoryHelper

Helper class that contains methods to retrieve and manipulate SDK locations.

EmptyAssetUpgrader

Empty asset upgrader (useful when we want to bump version without changing anything).

FileUtility

File Utilities methods.

FileVersionManager
Package

A package managing assets.

PackageAssetCollection

A collection of AssetItem that contains only absolute location without any drive information. This class cannot be inherited.

PackageCollection

A collection of Package.

PackageContainer
PackageDependency

A reference to a package either internal (directly to a Package inside the same solution) or external (to a package distributed on the store).

PackageDependencyCollection

A collection of PackageDependency.

PackageExtensions

Extensions for Package

PackageLoadParameters

Parameters used for loading a package.

PackageLoadedAssembly

Represents an assembly that is loaded at runtime by the package.

PackageLoadingAssetFile

Represents an asset before being loaded. Used mostly for asset upgrading.

PackageLoadingAssetFile.FileSizeComparer
PackageLoadingAssetFile.YamlAsset
PackageMeta

Metadata for a Package accessible from PackageMeta.

PackageReferenceBase

Common class used by PackageDependency.

PackageSaveParameters
PackageSession

A session for editing a package.

PackageSession.PendingPackageUpgrade
PackageSessionExtensions

Extension methods for PackageSession.

PackageSessionProfilingKeys

Keys used for profiling the game class.

PackageSessionPublicHelper

Helper class to load/save a VisualStudio solution.

PackageSessionResult

Result returned when loading a session using Load(string, PackageLoadParameters?)

PackageStore

Manage packages locally installed and accessible on the store.

PackageUpgrader

Offers a way for package to upgrade dependent packages. For example, if you write package A and Game1 depends on it, you might want to offer a new version of package A that would automatically perform some upgrades on Game1.

PackageUpgraderAttribute

Attribute that describes what a package upgrader can do.

PackageUserSettings

A class representing the user settings related to a Package. These settings are stored in a .user file along the package file.

PackageVersionRangeExtensions
PendingCodeUpgrade

One project pending source migration: the upgrader that declared the rules, the project file, and the version the project is being upgraded from (the symbol-resolution baseline).

ProjectCollection
ProjectReference

A reference to a Visual Studio project that is part of a Package

ProjectSourceCodeAsset
ProjectSourceCodeWithFileGeneratorAsset
PropertyCollection

A collection of properties.

RawAsset

A raw asset, an asset that is imported as-is.

RawAssetImporter
RawAssetImporterBase<TAsset>
RootAssetCollection
SolutionConfiguration

A solution configuration used by SolutionPlatform

SolutionConfigurationCollection

A collection of SolutionConfiguration

SolutionPlatform

Defines a solution platform.

SolutionPlatformCollection

A collection of SolutionPlatform.

SolutionPlatformPart

Class SolutionAlternativePlatform.

SolutionPlatformPartCollection

A collection of SolutionPlatformPart

SolutionPlatformTemplate

Defines a custom project template for a SolutionPlatform.

SolutionProject
SourceCodeAsset

Class SourceCodeAsset.

SourceFileMemberAttribute

An attribute indicating whether a member of an asset represents the path to a source file for this asset.

StandalonePackage
StridePackagesToSkipUpgrade
SupportedProgrammingLanguage

Represents a programming language supported by the system.

SupportedProgrammingLanguages

Provides a list of programming languages supported by the system.

TagCollection

A collection of tags.

TemplateFolder

Describes a template folder.

UPathAttribute

Specifies how to normalize a UPath stored in a class after loading/saving an asset.

UnloadableObjectRemover

Removes objects implementing 'IYamlProxy' from the object.

UpgradeBackup

Copy-on-write snapshot of the files an in-place upgrade is about to overwrite. Armed by BackupBeforeUpgrade and called from each upgrade write point right before it overwrites a file. The timestamped backup folder is created lazily on the first real snapshot (so nothing is written when an upgrade modifies no files), and each original is copied at most once (a file may be touched by several upgraders).

VSProjectHelper

Structs

AssetId
AssetMember

Represents a member of an asset.

AssetPart

A part asset contained by an asset that is IAssetComposite.

UnloadableObjectRemover.UnloadableItem

Interfaces

IAssetComposite

An interface that defines the composition declared by an asset inheriting from another asset.

IAssetFactory<T>

An interface that represents an asset factory.

IAssetFinder
IAssetImporter

Imports a raw asset into the asset system.

IAssetPartDesign

An interface representing a design-time part in an AssetComposite.

IAssetPartDesign<TAssetPart>

An interface representing a design-time part in an AssetComposite.

IAssetUpgrader
IAssetWithSource
ICancellableAsyncBuild
ICodeUpgradeRunner

Runs the source-code migrations declared by package upgraders over the projects being upgraded, before their package references are bumped — so symbols still resolve against the old version.

IFileSynchronizable

Identify an object that is associated with an anchor file on the disk where all the Stride.Core.IO.UPath members of this instance are relative to the FullPath of this instance.

IProjectAsset

An asset that is stored in a project file (such as .csproj).

IProjectFileGeneratorAsset

An asset that generates another file.

IReadOnlyPackageCollection

Enums

AssetClonerFlags

Flags used by AssetCloner

DependencyType
OverrideUpgraderHint

Defines a context for overrides when upgrading an asset.

PackageState
PackageUpgradeRequestedAnswer

An enum representing the user answer to a package upgrade request.

ProjectType

Type of the project.

SearchDirection

A direction to search for files in directories

UPathRelativeTo

Enum UPathRelativeTo

Delegates

DirtyFlagChangedDelegate<T>

A delegate used for events raised when the dirty flag of an object has changed