Skip to main content

Class AssetsInstaller

Namespace: RealityCollective.ServiceFramework.Editor.Packages

Installs plugin package assets.

public static class AssetsInstaller

Inheritance​

object ← AssetsInstaller

Fields​

AssetsInstalled​

The installer has installed package assets to the project.

public static Action<AssetsInstaller.AssetInstallerEventArgs> AssetsInstalled

Field Value​

Action<AssetsInstaller.AssetInstallerEventArgs>

Methods​

TryInstallAssets(string, string, bool, bool, bool)​

Attempt to copy any assets found in the source path into the project.

public static bool TryInstallAssets(string sourcePath, string destinationPath, bool regenerateGuids = false, bool skipDialog = false, bool onlyUnityAssets = false)

Parameters​

sourcePath string

The source path of the assets to be installed. This should typically be from a hidden upm package folder marked with a "~".

destinationPath string

The destination path, typically inside the projects "Assets" directory.

regenerateGuids bool

Should the guids for the copied assets be regenerated?

skipDialog bool

If set, assets and configuration is installed without prompting the user.

onlyUnityAssets bool

Filter the assets from the package to ONLY those provided by Unity, the default is ALL files.

Returns​

bool

true if the assets were successfully installed to the project.

TryInstallAssets(Dictionary<string, string>, bool, bool, bool)​

Attempt to copy any assets found in the source path into the project.

public static bool TryInstallAssets(Dictionary<string, string> installationPaths, bool regenerateGuids = false, bool skipDialog = false, bool onlyUnityAssets = false)

Parameters​

installationPaths Dictionary<string, string>

The assets paths to be installed. Key is the source path of the assets to be installed. This should typically be from a hidden upm package folder marked with a "~". Value is the destination.

regenerateGuids bool

Should the guids for the copied assets be regenerated?

skipDialog bool

If set, assets and configuration is installed without prompting the user.

onlyUnityAssets bool

Filter the assets from the package to ONLY those provided by Unity, the default is ALL files.

Returns​

bool

true if the assets were successfully installed to the project.