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

A reference to a local package loaded into the same PackageSession. More...

Public Member Functions

 PackageReference ()
 Initializes a new instance of the PackageReference class. More...
 
 PackageReference (Guid id, UFile location)
 Initializes a new instance of the PackageReference class. More...
 
PackageReference Clone ()
 Clones this instance. More...
 
override string ToString ()
 

Static Public Member Functions

static bool TryParse (string packageReferenceAsText, out PackageReference packageReference)
 Tries to parse a package reference in the format {guid:location}. More...
 
static implicit operator PackageReference (Package package)
 Performs an implicit conversion from Package to PackageReference. More...
 

Properties

Guid Id [get, set]
 Gets or sets the identifier of the package. More...
 
UFile Location [get, set]
 Gets or sets the location of the package description file on the disk, relative to the package that is holding this reference. More...
 

Detailed Description

A reference to a local package loaded into the same PackageSession.

Definition at line 13 of file PackageReference.cs.

Constructor & Destructor Documentation

SiliconStudio.Assets.PackageReference.PackageReference ( )

Initializes a new instance of the PackageReference class.

Definition at line 18 of file PackageReference.cs.

SiliconStudio.Assets.PackageReference.PackageReference ( Guid  id,
UFile  location 
)

Initializes a new instance of the PackageReference class.

Parameters
idThe identifier.
locationThe location.

Definition at line 27 of file PackageReference.cs.

Member Function Documentation

PackageReference SiliconStudio.Assets.PackageReference.Clone ( )

Clones this instance.

Returns
PackageReference.

Definition at line 50 of file PackageReference.cs.

static implicit SiliconStudio.Assets.PackageReference.operator PackageReference ( Package  package)
static

Performs an implicit conversion from Package to PackageReference.

Parameters
packageThe package.
Returns
The result of the conversion.

Definition at line 79 of file PackageReference.cs.

References SiliconStudio.Assets.Package.FullPath, and SiliconStudio.Assets.Asset.Id.

override string SiliconStudio.Assets.PackageReference.ToString ( )

Definition at line 84 of file PackageReference.cs.

static bool SiliconStudio.Assets.PackageReference.TryParse ( string  packageReferenceAsText,
out PackageReference  packageReference 
)
static

Tries to parse a package reference in the format {guid:location}.

Parameters
packageReferenceAsTextThe package reference as text.
packageReferenceThe package reference.
Returns
true if the package reference is a valid reference, false otherwise.

Definition at line 61 of file PackageReference.cs.

References SiliconStudio.Assets.AssetReference.TryParse().

Property Documentation

Guid SiliconStudio.Assets.PackageReference.Id
getset

Gets or sets the identifier of the package.

The identifier.

Definition at line 37 of file PackageReference.cs.

UFile SiliconStudio.Assets.PackageReference.Location
getset

Gets or sets the location of the package description file on the disk, relative to the package that is holding this reference.

The location.

Definition at line 44 of file PackageReference.cs.


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