UnityHub
in package
FinalYes
Process-wide facade for Unity Hub discovery, editor installation, and project/package lookup.
Tags
Table of Contents
Methods
- addLicenseFolder() : void
- createEditorInstallation() : array<string|int, mixed>
- createModuleInstallation() : array<string|int, mixed>
- execute() : Process
- findLicenses() : iterable<string|int, mixed>
- findPackage() : UnityPackage|null
- findProject() : UnityProject|null
- getEditorByVersion() : UnityEditor
- getEditorPath() : string
- getEditors() : array<string|int, mixed>
- getHubLocator() : HubLocatorInterface
- getInstance() : self
- getLoggingEnabled() : bool
- getProcessTimeout() : int
- getThrowOnFailure() : bool
- installEditor() : void
- installEditorModule() : void
- inventChangeset() : string
- inventStableEditorVersion() : string
- isInstalled() : bool
- prepareLicense() : void
- registerChangeset() : void
- runUnityProcess() : void
- setHubLocator() : void
- setLoggingEnabled() : void
- setProcessTimeout() : void
- setThrowOnFailure() : void
Methods
addLicenseFolder()
public
static addLicenseFolder(string $folder) : void
Parameters
- $folder : string
createEditorInstallation()
public
createEditorInstallation(string $version[, array<string|int, mixed> $modules = [] ]) : array<string|int, mixed>
Parameters
- $version : string
- $modules : array<string|int, mixed> = []
Return values
array<string|int, mixed>createModuleInstallation()
public
createModuleInstallation(string $version[, array<string|int, mixed> $modules = [] ]) : array<string|int, mixed>
Parameters
- $version : string
- $modules : array<string|int, mixed> = []
Return values
array<string|int, mixed>execute()
public
execute(string ...$arguments) : Process
Parameters
- $arguments : string
Return values
ProcessfindLicenses()
public
findLicenses(string $editorVersion) : iterable<string|int, mixed>
Parameters
- $editorVersion : string
Return values
iterable<string|int, mixed>findPackage()
public
findPackage(string $projectPath[, bool $includeSubdirectories = false ]) : UnityPackage|null
Parameters
- $projectPath : string
- $includeSubdirectories : bool = false
Return values
UnityPackage|nullfindProject()
public
findProject(string $projectPath[, bool $includeSubdirectories = false ]) : UnityProject|null
Parameters
- $projectPath : string
- $includeSubdirectories : bool = false
Return values
UnityProject|nullgetEditorByVersion()
public
getEditorByVersion(string $version) : UnityEditor
Parameters
- $version : string
Return values
UnityEditorgetEditorPath()
public
getEditorPath() : string
Return values
stringgetEditors()
public
getEditors() : array<string|int, mixed>
Return values
array<string|int, mixed>getHubLocator()
public
static getHubLocator() : HubLocatorInterface
Return values
HubLocatorInterfacegetInstance()
public
static getInstance() : self
Return values
selfgetLoggingEnabled()
public
static getLoggingEnabled() : bool
Return values
boolgetProcessTimeout()
public
static getProcessTimeout() : int
Return values
intgetThrowOnFailure()
public
static getThrowOnFailure() : bool
Return values
boolinstallEditor()
public
installEditor(UnityEditor $editor, string ...$modules) : void
Parameters
- $editor : UnityEditor
- $modules : string
installEditorModule()
public
installEditorModule(UnityEditor $editor, string ...$modules) : void
Parameters
- $editor : UnityEditor
- $modules : string
inventChangeset()
public
inventChangeset(string $version) : string
Parameters
- $version : string
Return values
stringinventStableEditorVersion()
public
inventStableEditorVersion(string $minVersion) : string
Parameters
- $minVersion : string
Return values
stringisInstalled()
public
isInstalled() : bool
Return values
boolprepareLicense()
public
prepareLicense(string $licenseFile) : void
Parameters
- $licenseFile : string
registerChangeset()
public
registerChangeset(string $version, string $changeset) : void
Parameters
- $version : string
- $changeset : string
runUnityProcess()
public
static runUnityProcess(Process $process[, bool $validateExitCode = true ]) : void
Parameters
- $process : Process
- $validateExitCode : bool = true
setHubLocator()
public
static setHubLocator(HubLocatorInterface $value) : void
Parameters
- $value : HubLocatorInterface
setLoggingEnabled()
public
static setLoggingEnabled(bool $value) : void
Parameters
- $value : bool
setProcessTimeout()
public
static setProcessTimeout(int $value) : void
Parameters
- $value : int
setThrowOnFailure()
public
static setThrowOnFailure(bool $value) : void
Parameters
- $value : bool