UnityProject
in package
FinalYes
Represents a Unity project and exposes editor automation operations for it.
Tags
Table of Contents
Methods
- __construct() : mixed
- __toString() : string
- build() : Process
- ensureEditorIsInstalled() : bool
- ensureEditorIsLicensed() : bool
- execute() : Process
- executeMethod() : Process
- getAssetFiles() : iterable<string|int, mixed>
- getEditorVersion() : string
- getPackages() : array<string|int, mixed>
- getProjectPath() : string
- getProjectVersion() : string
- getScriptingBackend() : int
- getSetting() : mixed
- hasSetting() : bool
- installModules() : bool
- runTests() : DOMDocument
- setProjectVersion() : void
- startMethod() : Process
Methods
__construct()
public
__construct(UnityProjectInfo $info, UnityHub $hub) : mixed
Parameters
- $info : UnityProjectInfo
- $hub : UnityHub
__toString()
public
__toString() : string
Return values
stringbuild()
public
build(string $target, string $buildPath) : Process
Parameters
- $target : string
- $buildPath : string
Return values
ProcessensureEditorIsInstalled()
public
ensureEditorIsInstalled() : bool
Return values
boolensureEditorIsLicensed()
public
ensureEditorIsLicensed() : bool
Return values
boolexecute()
public
execute(string ...$arguments) : Process
Parameters
- $arguments : string
Return values
ProcessexecuteMethod()
public
executeMethod(string $method, array<string|int, mixed> $args) : Process
Parameters
- $method : string
- $args : array<string|int, mixed>
Return values
ProcessgetAssetFiles()
public
getAssetFiles() : iterable<string|int, mixed>
Return values
iterable<string|int, mixed>getEditorVersion()
public
getEditorVersion() : string
Return values
stringgetPackages()
public
getPackages() : array<string|int, mixed>
Return values
array<string|int, mixed>getProjectPath()
public
getProjectPath() : string
Return values
stringgetProjectVersion()
public
getProjectVersion() : string
Return values
stringgetScriptingBackend()
public
getScriptingBackend() : int
Return values
intgetSetting()
public
getSetting(string $key[, mixed $defaultValue = null ]) : mixed
Parameters
- $key : string
- $defaultValue : mixed = null
hasSetting()
public
hasSetting(string $key) : bool
Parameters
- $key : string
Return values
boolinstallModules()
public
installModules(string ...$modules) : bool
Parameters
- $modules : string
Return values
boolrunTests()
public
runTests(string ...$testPlatforms) : DOMDocument
Parameters
- $testPlatforms : string
Return values
DOMDocumentsetProjectVersion()
public
setProjectVersion(string $version) : void
Parameters
- $version : string
startMethod()
public
startMethod(string $method, array<string|int, mixed> $args) : Process
Parameters
- $method : string
- $args : array<string|int, mixed>