Documentation

UnityHub
in package

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, UnityEditor>
getHubLocator()  : HubLocatorInterface
getInstance()  : self
getLoggingEnabled()  : bool
getProcessTimeout()  : int
getThrowOnFailure()  : bool
installEditor()  : void
installEditorModule()  : void
inventStableEditorVersion()  : string
isInstalled()  : mixed
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
Process

findLicenses()

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|null

findProject()

public findProject(string $projectPath[, bool $includeSubdirectories = false ]) : UnityProject|null
Parameters
$projectPath : string
$includeSubdirectories : bool = false
Return values
UnityProject|null

getEditorPath()

public getEditorPath() : string
Return values
string

getInstance()

public static getInstance() : self
Return values
self

getLoggingEnabled()

public static getLoggingEnabled() : bool
Return values
bool

getProcessTimeout()

public static getProcessTimeout() : int
Return values
int

getThrowOnFailure()

public static getThrowOnFailure() : bool
Return values
bool

installEditorModule()

public installEditorModule(UnityEditor $editor, string ...$modules) : void
Parameters
$editor : UnityEditor
$modules : string

inventStableEditorVersion()

public inventStableEditorVersion(string $minVersion) : string
Parameters
$minVersion : string
Return values
string

isInstalled()

public isInstalled() : mixed

prepareLicense()

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

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results