Pakku/teksturepako.pakku.api.data/LockFile

LockFile

data class LockFile(target: String? = null, mcVersions: MutableList<String> = mutableListOf(), loaders: MutableMap<String, String> = mutableMapOf(), projects: MutableList<Project> = mutableListOf(), lockFileVersion: Int = 2)

A lock file (pakku-lock.json) is an automatically generated file used by Pakku to define all properties of a modpack needed for its development.

This file is not intended to be modified manually.

Constructors

constructor(target: String? = null, mcVersions: MutableList<String> = mutableListOf(), loaders: MutableMap<String, String> = mutableMapOf(), projects: MutableList<Project> = mutableListOf(), lockFileVersion: Int = 2)

Types

object Companion

data class TargetNotFound(val target: String? = null) : ActionError

Functions

fun add(project: Project): Boolean?

fun addAll(projects: Collection<Project>): Boolean

fun addLoader(loaderName: String, loaderVersion: String)

fun addPakkuLink(pakkuId: String, project: Project): <Error class: unknown class>?

fun bumped(): LockFile

Returns a new LockFile with the version bumped to the latest version. This is used during migration to mark that the lockfile has been upgraded.

fun getAllProjects(): List<Project>

getFirstMcVersion

fun getFirstMcVersion(): <Error class: unknown class>

getLinkedProjects

fun getLinkedProjects(pakkuId: String): List<Project>

fun getLinkedProjects(pakkuId: String, ignore: Project): List<Project>

fun getLoaders(): <Error class: unknown class>

getLoadersWithVersions

fun getLoadersWithVersions(): <Error class: unknown class>

getLockFileVersion

fun getLockFileVersion(): Int

fun getMcVersions(): MutableList<String>

fun getPlatforms(): <Error class: unknown class><List<Platform>, ActionError>

fun getProject(input: String): Project?

fun getProject(project: Project): Project?

getProjectByPakkuId

fun getProjectByPakkuId(pakkuId: String): Project?

getProjectProvider

fun getProjectProvider(): <Error class: unknown class><Provider, ActionError>

fun inheritConfig(configFile: ConfigFile?)

fun isProjectAdded(project: Project): Boolean

linkProjectToDependents

fun linkProjectToDependents(project: Project)

fun remove(project: Project): Boolean?

removeAllProjects

fun removeAllProjects()

removePakkuLinkFromAllProjects

fun removePakkuLinkFromAllProjects(pakkuId: String): <Error class: unknown class>

removeProjectByPakkuId

fun removeProjectByPakkuId(pakkuId: String): Boolean?

fun setLoader(loaderName: String, loaderVersion: String)

fun setLoaders(loaders: Map<String, String>)

fun setMcVersions(mcVersions: Collection<String>)

fun setTarget(target: String)

fun update(project: Project): Boolean?

fun updateAll(projects: Collection<Project>): Boolean

suspend fun write(): ActionError?