Sample
Struct for a package's sample, which is accessible from the Details panel of the Package Manager window.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Struct
- Namespace: UnityEditor.PackageManager.UI
- Assembly: UnityEditor.CoreModule
public struct Sample
Properties
Property | Description |
|---|---|
| description | The description of the package sample. |
| displayName | The display name of the package sample. |
| images | Indicates the relative paths to where images used in the sample's description are located within the package. |
| importPath | The full path to where the sample will be imported, under the project assets folder. |
| interactiveImport | Indicates whether to show the import window when importing a sample that is an asset package (a .unitypackage file). |
| isImported | Indicates if the sample has already been imported. |
| resolvedPath | The full path to where the sample is on disk, inside the package that contains the sample. |
Methods
Method | Description |
|---|---|
| Import | Imports the package sample into the |
Static Methods
Method | Description |
|---|---|
| FindByPackage | Finds a list of samples in a package based on a specific version. |
Static Events
Member | Description |
|---|---|
| OnBeforeImportFinish | Raised after files are imported into the project, but before the Asset Database refreshes. |
Enums
Enum | Description |
|---|---|
| Sample.ImportOptions | Sample import options. |