Sample

struct in UnityEditor.PackageManager.UI

Leave feedback

Suggest a change

Switch to Manual

Description

Struct for a package's sample, which is accessible from the Details panel of the Package Manager window.

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.

Public Methods

Method	Description
Import	Imports the package sample into the `Assets` folder.

Static Methods

Method	Description
FindByPackage	Finds a list of samples in a package based on a specific version.

Events

Event	Description
OnBeforeImportFinish	Raised after files are imported into the project, but before the Asset Database refreshes.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Scripting API