Pakku/teksturepako.pakku.api.actions.export

Package-level declarations

Types

open class ExportProfile(val name: String, val fileExtension: String = "zip", val rules: List<ExportRule?>, val requiresPlatform: Platform? = null)

An export profile is used to contain a list of export rules.

class ExportProfileBuilder(name: String, fileExtension: String = "zip", requiresPlatform: Platform? = null, builder: ExportProfileBuilder.() -> Unit, rules: <Error class: unknown class><ExportRule> = sequenceOf()) : ExportRuleScope

fun interface ExportRule

A functional interface used to declare rules which control what should happen with the content you want to export/package.

sealed class Packaging

Packaging class is used to store the action of a rule result.

sealed class RuleContext

Rule Context keeps track of currently exporting content.

data class RuleResult(val message: String, val ruleContext: RuleContext, val packaging: Packaging)

suspend fun export(profiles: List<ExportProfileBuilder>, onError: suspend (profile: ExportProfile, error: ActionError) -> Unit, onSuccess: suspend (profile: ExportProfile, <Error class: unknown class>, <Error class: unknown class>) -> Unit, lockFile: LockFile, configFile: ConfigFile, platforms: List<Platform>): List<<Error class: unknown class>>

suspend fun ExportProfile.export(onError: suspend (profile: ExportProfile, error: ActionError) -> Unit, onSuccess: suspend (profile: ExportProfile, <Error class: unknown class>, <Error class: unknown class>) -> Unit, lockFile: LockFile, configFile: ConfigFile, platforms: List<Platform>, overrides: OverridesDeferred)

suspend fun exportDefaultProfiles(onError: suspend (profile: ExportProfile, error: ActionError) -> Unit, onSuccess: suspend (profile: ExportProfile, <Error class: unknown class>, <Error class: unknown class>) -> Unit, lockFile: LockFile, configFile: ConfigFile, platforms: List<Platform>): List<<Error class: unknown class>>

fun exportProfile(name: String, fileExtension: String = "zip", requiresPlatform: Platform? = null, builder: ExportProfileBuilder.() -> Unit): ExportProfileBuilder

Creates an export profile with customized settings and export rules.

Runs through a list of ExportRules, applies data to their RuleContexts and transforms them into RuleResults.

suspend fun List<RuleResult>.runEffects(onError: suspend (error: ActionError) -> Unit): List<<Error class: unknown class><<Error class: unknown class>?>>

suspend fun List<RuleResult>.runEffectsOnFinished(onError: suspend (error: ActionError) -> Unit): List<<Error class: unknown class><<Error class: unknown class>?>>