TemplateDescription Class

    Namespace: Stride.Core.Assets.Templates
    Assembly: Stride.Core.Assets.dll

    Description of a template generator that can be displayed in the GameStudio.

    System.Object → TemplateDescription
    Derived from TemplateDescription: TemplateAssetDescription TemplateSampleDescription 

    [DataContract("Template")]
public class TemplateDescription : IFileSynchronizable
    Name Description
    Fields
    FileExtension

    The file extension used when loading/saving this template description.
    Properties
    DefaultOutputName

    Gets or set the default name for the output package/library.
    Description

    Gets or sets the description.
    FullDescription

    Gets or sets a longer description.
    FullPath

    Gets the full path on disk where this instance is stored.
    Group

    Gets or sets the group.
    Icon

    Gets or sets the icon/bitmap.
    Id

    Gets or sets the unique identifier.
    IsDirty

    Gets or sets a value indicating whether this instance is dirty.
    Name

    Gets or sets the short name of this template

    Order

    Gets or sets the order (lower value means higher order)
    Scope

    Gets or sets the scope of this template.
    Screenshots

    Gets the screenshots.
    Status

    Gets or sets the status.
    TemplateDirectory

    Gets the directory from where this template was loaded
    | Improve this Doc View Source

    Fields

    FileExtension

    The file extension used when loading/saving this template description.

    public const string FileExtension = ".sdtpl"
    Field Value
    Type Description
    System.String
    | Improve this Doc View Source

    Properties

    DefaultOutputName

    Gets or set the default name for the output package/library.

    [DataMember(45)]
public string DefaultOutputName { get; set; }
    Property Value
    Type Description
    System.String

    The default output name.

    Description

    Gets or sets the description.

    [DataMember(40)]
public string Description { get; set; }
    Property Value
    Type Description
    System.String

    The description.

    FullDescription

    Gets or sets a longer description.

    [DataMember(43)]
public string FullDescription { get; set; }
    Property Value
    Type Description
    System.String

    The longer description.

    FullPath

    Gets the full path on disk where this instance is stored.

    public UFile FullPath { get; set; }
    Property Value
    Type Description
    Stride.Core.IO.UFile

    The full path.

    Group

    Gets or sets the group.

    [DataMember(20)]
public string Group { get; set; }
    Property Value
    Type Description
    System.String

    The group.

    Icon

    Gets or sets the icon/bitmap.

    [DataMember(30)]
public UFile Icon { get; set; }
    Property Value
    Type Description
    Stride.Core.IO.UFile

    The icon.

    Id

    Gets or sets the unique identifier.

    [DataMember(0)]
public Guid Id { get; set; }
    Property Value
    Type Description
    System.Guid

    The identifier.

    IsDirty

    Gets or sets a value indicating whether this instance is dirty.

    public bool IsDirty { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is dirty; otherwise, false.

    Name

    Gets or sets the short name of this template 

    [DataMember(10)]
public string Name { get; set; }
    Property Value
    Type Description
    System.String

    The name.

    Order

    Gets or sets the order (lower value means higher order)

    [DataMember(17)]
public int Order { get; set; }
    Property Value
    Type Description
    System.Int32

    The order.

    Scope

    Gets or sets the scope of this template.

    [DataMember(15)]
public TemplateScope Scope { get; set; }
    Property Value
    Type Description
    TemplateScope

    The context.

    Screenshots

    Gets the screenshots.

    [DataMember(30)]
public List<UFile> Screenshots { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<Stride.Core.IO.UFile>

    The screenshots.

    Status

    Gets or sets the status.

    [DataMember(60)]
public TemplateStatus Status { get; set; }
    Property Value
    Type Description
    TemplateStatus

    The status.

    TemplateDirectory

    Gets the directory from where this template was loaded

    public UDirectory TemplateDirectory { get; }
    Property Value
    Type Description
    Stride.Core.IO.UDirectory

    The resource directory.

    Extension Methods