Options
All
  • Public
  • Public/Protected
  • All
Menu

A fluent builder for the advanced installer to simplify configuration.

Hierarchy

  • AdvancedInstallerBuilder

Index

Constructors

constructor

  • Creates a new instance of the builder for configuration.

    Parameters

    • gameId: string

      The game ID for this installer.

    • Optional modFileExt: string

      The mod file extension, defaults to .pak.

    • Optional warnOnFileRoots: number

      The maximum number of installation root options before warning the user.

    Returns AdvancedInstallerBuilder

Methods

addCompatibilityTest

  • Adds a compatibility test to be run during install to catch malformed or incompatible mods.

    remarks

    Unlike extenders and support tests, there can only be one compatibility test. Calling this again will replace earlier tests.

    Parameters

    Returns AdvancedInstallerBuilder

    The builder.

addExtender

  • Adds an instruction extender for including additional instructions during install.

    remarks

    Instruction extenders are called after the user has chosen what files to install.

    Parameters

    • processor: InstructionExtender

      The instruction extender to be invoked during installation.

    • Optional test: (state: IState) => boolean

      An optional test to determine whether to run the extender.

        • (state: IState): boolean
        • Parameters

          • state: IState

          Returns boolean

    Returns AdvancedInstallerBuilder

    The builder.

addSupportedCheck

build

useCustomMessages

Generated using TypeDoc