Python Script Engine
8.0
GL Studio Editor Python Script API
|
Module Methods | |
int | InstallPackageIntoRepo (PackageManager::Package &package, bool installDependencies=true) |
int | InstallPackageIntoProject (PackageManager::Package &package, Project &projectToInstallInto, Kitting::ComparableVersion *referencedVersion) |
void | UninstallPackage (PackageManager::Package &package) |
PackageManager::Package | CreatePackage (String packagePath) |
std::vector< PackageManager::Package > | GetPackagesFor (Project &project) |
std::vector< PackageManager::Package > | GetRepoPackages () |
DependencyInfo | GetDependencies (PackageManager::Package &package) |
Package Manager module that contains methods to run on the PackageManager instance itself.
PackageManager::Package CreatePackage | ( | String | packagePath | ) |
Creates a package from a given packagePath.
packagePath | Either a zip file or a folder containing a package manifest. |
DependencyInfo GetDependencies | ( | PackageManager::Package & | package | ) |
Retrieves a list of dependencies for a package that are next to the specified package in the file system.
std::vector< PackageManager::Package > GetPackagesFor | ( | Project & | project | ) |
Retrieves a list of packages for a given project.
std::vector< PackageManager::Package > GetRepoPackages | ( | ) |
Retrieves a list of packages installed in the repo.
int InstallPackageIntoProject | ( | PackageManager::Package & | package, |
Project & | projectToInstallInto, | ||
Kitting::ComparableVersion * | referencedVersion | ||
) |
Installs the package into the project.
Does not install dependencies. If the package is already installed, it attempts to resolve the conflict.
package | The package object to be installed. |
projectToInstallInto | The project to install into. |
referencedVersion | The comparable version used to find the correct package version if the package is a reference |
If | there is a catastrophic error such as write permission is denied, the project file is invalid (see IsValidPackage()), or the given project does not exist on disk. |
int InstallPackageIntoRepo | ( | PackageManager::Package & | package, |
bool | installDependencies = true |
||
) |
Installs the package into the global package space for all projects to use If the package is already installed, it attempts to resolve the conflict.
package | The package object to be installed. |
installDependencies | whether or not to install the package's dependencies |
If | there is a catastrophic error such as write permission is denied |
void UninstallPackage | ( | PackageManager::Package & | package | ) |
Uninstalls the package.
package | The package object to be uninstalled. |
If | there is a catastrophic error such as write permission is denied |