Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Assets.Templates.TemplateDescription Class Reference

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

Inheritance diagram for SiliconStudio.Assets.Templates.TemplateDescription:
SiliconStudio.Assets.IFileSynchronizable SiliconStudio.Assets.IDirtyable SiliconStudio.Assets.Templates.TemplateSampleDescription

Public Member Functions

 TemplateDescription ()
 Initializes a new instance of the TemplateDescription class. More...
 

Public Attributes

const string FileExtension = ".pdxtpl"
 The file extension used when loading/saving this template description. More...
 

Properties

Guid Id [get, set]
 Gets or sets the unique identifier. More...
 
string Name [get, set]
 Gets or sets the short name of this template More...
 
TemplateScope Scope [get, set]
 Gets or sets the scope of this template. More...
 
int Order [get, set]
 Gets or sets the order (lower value means higher order) More...
 
string Group [get, set]
 Gets or sets the group. More...
 
UFile Icon [get, set]
 Gets or sets the icon/bitmap. More...
 
List< UFileScreenshots [get, set]
 Gets the screenshots. More...
 
string Description [get, set]
 Gets or sets the description. More...
 
string FullDescription [get, set]
 Gets or sets a longer description. More...
 
string DefaultOutputName [get, set]
 Gets or set the default name for the output package/library. More...
 
TemplateStatus Status [get, set]
 Gets or sets the status. More...
 
bool IsDirty [get, set]
 
UFile FullPath [get, set]
 
UDirectory TemplateDirectory [get]
 Gets the directory from where this template was loaded More...
 
- Properties inherited from SiliconStudio.Assets.IFileSynchronizable
UFile FullPath [get]
 Gets the full path on disk where this instance is stored. More...
 
- Properties inherited from SiliconStudio.Assets.IDirtyable
bool IsDirty [get, set]
 Gets or sets a value indicating whether this instance is dirty. More...
 

Detailed Description

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

Definition at line 17 of file TemplateDescription.cs.

Constructor & Destructor Documentation

SiliconStudio.Assets.Templates.TemplateDescription.TemplateDescription ( )

Initializes a new instance of the TemplateDescription class.

Definition at line 27 of file TemplateDescription.cs.

Member Data Documentation

const string SiliconStudio.Assets.Templates.TemplateDescription.FileExtension = ".pdxtpl"

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

Definition at line 22 of file TemplateDescription.cs.

Property Documentation

string SiliconStudio.Assets.Templates.TemplateDescription.DefaultOutputName
getset

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

The default output name.

Definition at line 106 of file TemplateDescription.cs.

string SiliconStudio.Assets.Templates.TemplateDescription.Description
getset

Gets or sets the description.

The description.

Definition at line 91 of file TemplateDescription.cs.

string SiliconStudio.Assets.Templates.TemplateDescription.FullDescription
getset

Gets or sets a longer description.

The longer description.

Definition at line 99 of file TemplateDescription.cs.

UFile SiliconStudio.Assets.Templates.TemplateDescription.FullPath
getset

Definition at line 122 of file TemplateDescription.cs.

string SiliconStudio.Assets.Templates.TemplateDescription.Group
getset

Gets or sets the group.

The group.

Definition at line 68 of file TemplateDescription.cs.

UFile SiliconStudio.Assets.Templates.TemplateDescription.Icon
getset

Gets or sets the icon/bitmap.

The icon.

Definition at line 76 of file TemplateDescription.cs.

Guid SiliconStudio.Assets.Templates.TemplateDescription.Id
getset

Gets or sets the unique identifier.

The identifier.

Definition at line 37 of file TemplateDescription.cs.

bool SiliconStudio.Assets.Templates.TemplateDescription.IsDirty
getset

Definition at line 118 of file TemplateDescription.cs.

string SiliconStudio.Assets.Templates.TemplateDescription.Name
getset

Gets or sets the short name of this template

The name.

Definition at line 44 of file TemplateDescription.cs.

int SiliconStudio.Assets.Templates.TemplateDescription.Order
getset

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

The order.

Definition at line 60 of file TemplateDescription.cs.

TemplateScope SiliconStudio.Assets.Templates.TemplateDescription.Scope
getset

Gets or sets the scope of this template.

The context.

Definition at line 52 of file TemplateDescription.cs.

List<UFile> SiliconStudio.Assets.Templates.TemplateDescription.Screenshots
getset

Gets the screenshots.

The screenshots.

Definition at line 83 of file TemplateDescription.cs.

TemplateStatus SiliconStudio.Assets.Templates.TemplateDescription.Status
getset

Gets or sets the status.

The status.

Definition at line 114 of file TemplateDescription.cs.

UDirectory SiliconStudio.Assets.Templates.TemplateDescription.TemplateDirectory
get

Gets the directory from where this template was loaded

The resource directory.

Definition at line 130 of file TemplateDescription.cs.


The documentation for this class was generated from the following file: