AdvancedInstaller | vortex-ext-common

A flexible and configurable installer for game extensions, especially for UE4 games.

remarks: This installer should be capable of installation for non-UE4 games but we cannot provide support for that scenario.

Hierarchy

AdvancedInstaller

Index

Constructors

constructor

Methods

Constructors

constructor

new AdvancedInstaller(opts: IAdvancedInstallerOptions, supportedTests?: InstallSupportedTest[], processors?: InstructionProcessor[]): AdvancedInstaller

- Defined in install/advanced/AdvancedInstaller.ts:18
Creates a new instance of the advanced installer.

remarks

It is not recommended to use this in your extension, use the AdvancedInstallerBuilder instead.

Parameters
- opts: IAdvancedInstallerOptions
  
  Installer options.
- Optional supportedTests: InstallSupportedTest[]
  
  A collection of tests for supported mods.
- Optional processors: InstructionProcessor[]
  
  A set of processors for additional instructions.
Returns AdvancedInstaller

Methods

advancedInstall

advancedInstall(files: string[], destinationPath: string, gameId: string, progress: ProgressDelegate): Promise<IInstallResult>

- Defined in install/advanced/AdvancedInstaller.ts:85
The main installer function for the advanced installer. This can be passed to registerInstaller()

Parameters
- files: string[]
  
  The files to install.
- destinationPath: string
  
  The destination path for the install.
- gameId: string
  
  The current game ID.
- progress: ProgressDelegate
  
  A delegate for reporting progress.
Returns Promise<IInstallResult>

The result of the install.

configure

configure(api: IExtensionApi): AdvancedInstaller

- Defined in install/advanced/AdvancedInstaller.ts:42
Configures the installer with the current extension API. This must be called during extension loading or the installer will not run.

Parameters
- api: IExtensionApi
  
  The extension API.
Returns AdvancedInstaller

The installer.

testSupported

testSupported(files: string[], gameId: string): Promise<ISupportedResult>

- Defined in install/advanced/AdvancedInstaller.ts:53
Tests whether the current installation operation is supported for this installer.

Parameters
- files: string[]
  
  The files list.
- gameId: string
  
  The game ID.
Returns Promise<ISupportedResult>

A result for installation support.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

opts: IAdvancedInstallerOptions

Optional supportedTests: InstallSupportedTest[]

Optional processors: InstructionProcessor[]

Returns AdvancedInstaller

Methods

advancedInstall

Parameters

files: string[]

destinationPath: string

gameId: string

progress: ProgressDelegate

Returns Promise<IInstallResult>

configure

Parameters

api: IExtensionApi

Returns AdvancedInstaller

testSupported

Parameters

files: string[]

gameId: string

Returns Promise<ISupportedResult>