Search Results for

    Show / Hide Table of Contents

    Interface IAssetWithDirectory

    Interface representing an asset meta file that manages a directory (Directory, Effect, etc.).

    Inherited Members
    IAssetMetaFile.Id
    IAssetMetaFile.Name
    IAssetMetaFile.ExportAsRaw
    IAssetMetaFile.Exporter
    IAssetMetaFile.DefaultProfile
    IAssetMetaFile.Profiles
    IAssetMetaFile.AddProfile(string, AssetProfile)
    IAssetMetaFile.RemoveProfile(string)
    IAssetMetaFile.GetProfileOrDefault(string)
    IAssetMetaFile.Export(ExportContext)
    IAssetMetaFile.GetExportOutputPath(ExportContext)
    IAssetMetaFile.ExtensionMetafile
    IAssetMetaFile.ExtensionExported
    Namespace: Evergine.Assets.Exporters
    Assembly: Evergine.Assets.dll
    Syntax
    public interface IAssetWithDirectory : IAssetMetaFile

    Properties

    Assets

    Gets the contained assets.

    Declaration
    List<AssetItem> Assets { get; }
    Property Value
    Type Description
    List<AssetItem>

    SourceDirectory

    Gets or sets the resource file.

    Declaration
    ContentDirectory SourceDirectory { get; set; }
    Property Value
    Type Description
    ContentDirectory

    SourceDirectoryName

    Gets the name of the directory that this asset manages.

    Declaration
    string SourceDirectoryName { get; }
    Property Value
    Type Description
    string

    Methods

    AddAssetItem(AssetItem)

    Adds the asset item to the directory.

    Declaration
    void AddAssetItem(AssetItem assetItem)
    Parameters
    Type Name Description
    AssetItem assetItem

    The asset item.

    ChecksDirectoryIntegrity(ContentDirectory)

    Checks the integrity of this asset. A common behavior is to check if the source directory is available.

    Declaration
    bool ChecksDirectoryIntegrity(ContentDirectory parentDirectory)
    Parameters
    Type Name Description
    ContentDirectory parentDirectory

    The parent directory of this asset.

    Returns
    Type Description
    bool

    True if this asset passes the integrity check.

    EnumerateAllAssets()

    Enumerates all assets in this directory and its subdirectories.

    Declaration
    IEnumerable<AssetItem> EnumerateAllAssets()
    Returns
    Type Description
    IEnumerable<AssetItem>

    All assets in this directory and its subdirectories.

    FindAssetItem(string)

    Gets an asset contained in the directory by its name.

    Declaration
    AssetItem FindAssetItem(string name)
    Parameters
    Type Name Description
    string name

    The asset's name.

    Returns
    Type Description
    AssetItem

    The asset item.

    FindAssetItem(string, Type, bool)

    Gets an asset contained in the directory by its name.

    Declaration
    AssetItem FindAssetItem(string name, Type type, bool recursive = false)
    Parameters
    Type Name Description
    string name

    The asset's name.

    Type type

    The asset's type.

    bool recursive

    Indicates if the search is recursive.

    Returns
    Type Description
    AssetItem

    The asset item.

    FindAssetItem<T>(string, bool)

    Gets an asset contained in the directory by its name.

    Declaration
    AssetItem FindAssetItem<T>(string name, bool recursive = false) where T : IAssetMetaFile
    Parameters
    Type Name Description
    string name

    The asset name.

    bool recursive

    Whether the search is recursive.

    Returns
    Type Description
    AssetItem

    The asset item.

    Type Parameters
    Name Description
    T

    The type of the asset.

    FindAssetItems(Type)

    Gets an asset located in the directory by its name.

    Declaration
    List<AssetItem> FindAssetItems(Type type)
    Parameters
    Type Name Description
    Type type

    The type of the asset.

    Returns
    Type Description
    List<AssetItem>

    The asset item.

    FindAssetItems<T>()

    Gets an asset located in the directory by its type.

    Declaration
    List<AssetItem> FindAssetItems<T>() where T : IAssetMetaFile
    Returns
    Type Description
    List<AssetItem>

    The asset item.

    Type Parameters
    Name Description
    T

    The type of the asset.

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX