Pakku/teksturepako.pakku.api.projects/Project

Project

data class Project(var pakkuId: String? = null, val pakkuLinks: MutableSet<String> = mutableSetOf(), var type: ProjectType, var side: ProjectSide? = null, val slug: MutableMap<String, String>, val name: MutableMap<String, String>, val id: MutableMap<String, String>, var updateStrategy: UpdateStrategy = UpdateStrategy.LATEST, var redistributable: Boolean = true, subpath: String? = null, var aliases: MutableSet<String>? = null, var export: Boolean? = null, var files: MutableSet<ProjectFile>)

Represents a project. (E.g. a mod, resource pack, shader, etc.)

Constructors

Project

constructor(pakkuId: String? = null, pakkuLinks: MutableSet<String> = mutableSetOf(), type: ProjectType, side: ProjectSide? = null, slug: MutableMap<String, String>, name: MutableMap<String, String>, id: MutableMap<String, String>, updateStrategy: UpdateStrategy = UpdateStrategy.LATEST, redistributable: Boolean = true, subpath: String? = null, aliases: MutableSet<String>? = null, export: Boolean? = null, files: MutableSet<ProjectFile>)

Properties

aliases

var aliases: MutableSet<String>?

export

var export: Boolean?

files

var files: MutableSet<ProjectFile>

Mutable set of associated files.

val id: MutableMap<String, String>

Mutable map of platform name to id.

name

val name: MutableMap<String, String>

Mutable map of platform name to project name.

pakkuId

var pakkuId: String?

Pakku ID. Randomly generated and assigned when adding this project.

pakkuLinks

val pakkuLinks: MutableSet<String>

redistributable

var redistributable: Boolean

side

var side: ProjectSide?

The side required by this project. Defaults to ProjectSide.BOTH.

slug

val slug: MutableMap<String, String>

Mutable map of platform name to project slug, a short and lowercase version of the name.

type

var type: ProjectType

The type of the project. (E.g. a mod, resource pack, shader, etc.)

updateStrategy

var updateStrategy: UpdateStrategy

Functions

contains

operator fun contains(input: String): Boolean

Checks if the current project contains the specified string in its slugs, names, IDs or aliases.

createAdditionRequest

suspend fun Project?.createAdditionRequest(onError: suspend (error: ActionError) -> Unit, onSuccess: suspend (project: Project, isRecommended: Boolean, replacing: Project?, reqHandlers: RequestHandlers) -> Unit, lockFile: LockFile, platforms: List<Platform>, strict: Boolean = false)

createRemovalRequest

suspend fun Project?.createRemovalRequest(onError: suspend (error: ActionError) -> Unit, onRemoval: suspend (project: Project, isRecommended: Boolean) -> Unit, onDepRemoval: suspend (project: Project, isRecommended: Boolean) -> Unit, lockFile: LockFile)

getFilesForPlatform

fun getFilesForPlatform(platform: Platform): List<ProjectFile>

Retrieves a list of project files associated with the specified platform.

getFilesForProvider

fun getFilesForProvider(provider: Provider): List<ProjectFile>

getFilesForProviders

fun getFilesForProviders(vararg providers: Provider): List<ProjectFile>

fun getFilesForProviders(providers: Collection<Provider>): List<ProjectFile>

getFlavoredName

fun Project.getFlavoredName(theme: <Error class: unknown class>, maxLength: Int? = 20): String?

getFlavoredSlug

fun Project.getFlavoredSlug(): String

getFlavoredTargets

fun Project.getFlavoredTargets(platforms: List<Platform>): String

getFlavoredUpdateMsg

fun Project.getFlavoredUpdateMsg(theme: <Error class: unknown class>, updatedProjects: MutableSet<Project>): String

getFullMsg

fun Project.getFullMsg(): String

getLatestFile

fun getLatestFile(providers: Collection<Provider>): ProjectFile?

getPathStringWithSubpath

fun getPathStringWithSubpath(configFile: ConfigFile?, separator: Char = '/'): <Error class: unknown class>

getPlatforms

fun getPlatforms(): List<Platform>

getProviders

fun getProviders(): List<Provider>

getSubpath

fun getSubpath(): <Error class: unknown class><String, ActionError>?

getSubpathOrNull

fun getSubpathOrNull(): String?

hasAliasOf

infix fun hasAliasOf(other: Project): Boolean

Check if the current project has an alias of the specified project.

hasFiles

fun hasFiles(): Boolean

Checks if the project has any files.

hasFilesOn

fun hasFilesOn(provider: Provider): Boolean

Checks if the project has files on the specified provider.

hasFilesOnPlatform

fun hasFilesOnPlatform(platform: Platform): Boolean

Checks if the project has files on the specified platform.

hasNoFiles

fun hasNoFiles(): Boolean

Checks if the project has no files.

hasNoFilesOn

fun hasNoFilesOn(provider: Provider): Boolean

Checks if the project has no files on the specified provider.

hasNoFilesOnPlatform

fun hasNoFilesOnPlatform(platform: Platform): Boolean

Checks if the project has no files on the specified platform.

inheritPropertiesFrom

fun inheritPropertiesFrom(configFile: ConfigFile?): Project

isAlmostTheSameAs

infix fun isAlmostTheSameAs(other: Project): Boolean

Checks if the current project contains at least one slug, ID or name from the other project.

isNotOnPlatform

fun isNotOnPlatform(platform: Platform): Boolean

Checks if the project is not associated with the specified platform.

isOnPlatform

fun isOnPlatform(platform: Platform): Boolean

Checks if the project is associated with the specified platform.

plus

operator fun plus(other: Project): <Error class: unknown class><Project, ActionError>

Combines two projects of the same type into a new project.

requestDependencies

suspend fun requestDependencies(projectProvider: Provider, lockFile: LockFile): List<<Error class: unknown class><Project, ActionError>>

Requests projects with files for all dependencies of this project.

resolveDependencies

suspend fun Project.resolveDependencies(terminal: <Error class: unknown class>, reqHandlers: RequestHandlers, lockFile: LockFile, projectProvider: Provider, platforms: List<Platform>, onDependencyReq: suspend (project: Project, provider: Provider, lockfile: LockFile) -> List<<Error class: unknown class><Project, ActionError>> = { project, provider, _ -> project.requestDependencies(provider, lockFile) })

setSubpath

fun setSubpath(subpath: String): ActionError?

versionsDoNotMatchAcrossProviders

fun versionsDoNotMatchAcrossProviders(providers: List<Provider>): Boolean

Checks if versions do not match across specified providers.

versionsMatchAcrossProviders

fun versionsMatchAcrossProviders(providers: List<Provider>): Boolean

Checks if versions match across specified providers.