ModPack

@since

2.2.1b85

Index

Interfaces

• DirectoryExtractStrategy
• DirectoryRequestStrategy
• DirectorySetRequestHandler
• DirectoryUpdateStrategy
• IDirectoryAssignable
• ModPack
• ModPackDeclaredDirectory
• ModPackDirectory
• ModPackJsAdapter
• ModPackManifest
• ModPackManifestEditor
• ModPackPreferences

Type Aliases

• ModPackDeclaredDirectoryType
• ModPackDirectoryType

Interfaces

DirectoryExtractStrategy

DirectoryExtractStrategy:

assignToDirectory

• assignToDirectory(dir: ModPackDirectory): void

• Inherited from IDirectoryAssignable.assignToDirectory

  Parameters

  • dir: ModPackDirectory

  Returns void

getAssignedDirectory

• getAssignedDirectory(): ModPackDeclaredDirectory

• Inherited from IDirectoryAssignable.getAssignedDirectory

  Returns ModPackDeclaredDirectory

getEntryName

• getEntryName(str: string, file: File): string

• Parameters

  • str: string

  • file: File

  Returns string

getFilesToExtract

• getFilesToExtract(): List<File>

• Returns List<File>

getFullEntryName

• getFullEntryName(file: File): string

• Parameters

  • file: File

  Returns string

DirectoryRequestStrategy

DirectoryRequestStrategy:

assignToDirectory

• assignToDirectory(dir: ModPackDirectory): void

• Inherited from IDirectoryAssignable.assignToDirectory

  Parameters

  • dir: ModPackDirectory

  Returns void

assure

• assure(location: string, name: string): File

• Parameters

  • location: string

  • name: string

  Returns File

get

• get(str: string): File
• get(str: string, str2: string): File

• Parameters

  • str: string

  Returns File

getAll

• getAll(str: string): List<File>

• Parameters

  • str: string

  Returns List<File>

getAllFiles

• getAllFiles(): List<File>

• Returns List<File>

getAllLocations

• getAllLocations(): List<string>

• Returns List<string>

getAssignedDirectory

• getAssignedDirectory(): ModPackDeclaredDirectory

• Inherited from IDirectoryAssignable.getAssignedDirectory

  Returns ModPackDeclaredDirectory

remove

• remove(location: string, name: string): boolean

• Parameters

  • location: string

  • name: string

  Returns boolean

DirectorySetRequestHandler

DirectorySetRequestHandler:

add

• add(dir: ModPackDirectory): void

• Parameters

  • dir: ModPackDirectory

  Returns void

get

• get(location: string, name: string): File
• get(location: string): File

• Parameters

  • location: string

  • name: string

  Returns File

getAllAtLocation

• getAllAtLocation(location: string): List<File>

• Parameters

  • location: string

  Returns List<File>

getAllLocations

• getAllLocations(): List<string>

• Returns List<string>

getDirectories

• getDirectories(): List<ModPackDirectory>

• Returns List<ModPackDirectory>

DirectoryUpdateStrategy

DirectoryUpdateStrategy:

assignToDirectory

• assignToDirectory(dir: ModPackDirectory): void

• Inherited from IDirectoryAssignable.assignToDirectory

  Parameters

  • dir: ModPackDirectory

  Returns void

beginUpdate

• beginUpdate(): void

• Returns void

finishUpdate

• finishUpdate(): void

• Returns void

getAssignedDirectory

• getAssignedDirectory(): ModPackDeclaredDirectory

• Inherited from IDirectoryAssignable.getAssignedDirectory

  Returns ModPackDeclaredDirectory

updateFile

• updateFile(str: string, stream: InputStream): void

• Parameters

  • str: string

  • stream: InputStream

  Returns void

IDirectoryAssignable

IDirectoryAssignable:

assignToDirectory

• assignToDirectory(dir: ModPackDirectory): void

• Parameters

  • dir: ModPackDirectory

  Returns void

getAssignedDirectory

• getAssignedDirectory(): ModPackDeclaredDirectory

• Returns ModPackDeclaredDirectory

ModPack

ModPack:

addDirectory

• addDirectory(directory: ModPackDirectory): ModPack

• Parameters

  • directory: ModPackDirectory

  Returns ModPack

getAllDirectories

• getAllDirectories(): List<ModPackDirectory>

• Returns List<ModPackDirectory>

getDirectoriesOfType

• getDirectoriesOfType(type: number): List<ModPackDirectory>

• Parameters

  • type: number

  Returns List<ModPackDirectory>

getDirectoryOfType

• getDirectoryOfType(type: number): ModPackDirectory

• Parameters

  • type: number

  Returns ModPackDirectory

getExternalServersFile

• getExternalServersFile(): File

• @since

  2.3.1b116

  ---

  Returns File

getIconFile

• getIconFile(): File

• Returns File

getJsAdapter

• getJsAdapter(): ModPackJsAdapter

• Returns ModPackJsAdapter

getManifest

• getManifest(): ModPackManifest

• Returns ModPackManifest

getManifestFile

• getManifestFile(): File

• Returns File

getPreferences

• getPreferences(): ModPackPreferences

• Returns ModPackPreferences

getRequestHandler

• getRequestHandler(type: number): DirectorySetRequestHandler

• Parameters

  • type: number

  Returns DirectorySetRequestHandler

getRootDirectory

• getRootDirectory(): File

• Returns File

reloadAndValidateManifest

• reloadAndValidateManifest(): boolean

• Returns boolean

ModPackDeclaredDirectory

ModPackDeclaredDirectory:

readonlypath

path: string

readonlytype

type: number

getPath

• getPath(): string

• Returns string

getType

• getType(): number

• Returns number

ModPackDirectory

ModPackDirectory:

assignToModPack

• assignToModPack(pack: ModPack): void

• Parameters

  • pack: ModPack

  Returns void

assureDirectoryRoot

• assureDirectoryRoot(): boolean

• Returns boolean

getExtractStrategy

• getExtractStrategy(): DirectoryExtractStrategy

• Returns DirectoryExtractStrategy

getLocalPathFromEntry

• getLocalPathFromEntry(entryName: string): string

• Parameters

  • entryName: string

  Returns string

getLocation

• getLocation(): File

• Returns File

getPathPattern

• getPathPattern(): string

• Returns string

getPathPatternRegex

• getPathPatternRegex(): Pattern

• Returns Pattern

getRequestStrategy

• getRequestStrategy(): DirectoryRequestStrategy

• Returns DirectoryRequestStrategy

getType

• getType(): number

• Returns number

getUpdateStrategy

• getUpdateStrategy(): DirectoryUpdateStrategy

• Returns DirectoryUpdateStrategy

ModPackJsAdapter

ModPackJsAdapter:

Interface representing ModPack.

getAllDirectories

• getAllDirectories(): ModPackDirectory[]

• Returns ModPackDirectory[]

getDirectoriesOfType

• getDirectoriesOfType(type: string): ModPackDirectory[]

• Parameters

  • type: string

  Returns ModPackDirectory[]

getDirectoryOfType

• getDirectoryOfType(type: string): ModPackDirectory

• Parameters

  • type: string

  Returns ModPackDirectory

getManifest

• getManifest(): ModPackManifest

• Returns ModPackManifest

getModPack

• getModPack(): ModPack

• Returns ModPack

getModsDirectoryPath

• getModsDirectoryPath(): string

• Returns string

getPreferences

• getPreferences(): ModPackPreferences

• Returns ModPackPreferences

getRequestHandler

• getRequestHandler(type: string): DirectorySetRequestHandler

• Parameters

  • type: string

  Returns DirectorySetRequestHandler

getRootDirectory

• getRootDirectory(): File

• Returns File

getRootDirectoryPath

• getRootDirectoryPath(): string

• Returns string

ModPackManifest

ModPackManifest:

createDeclaredDirectoriesForModPack

• createDeclaredDirectoriesForModPack(pack: ModPack): List<ModPackDirectory>

• Parameters

  • pack: ModPack

  Returns List<ModPackDirectory>

edit

• edit(): ModPackManifestEditor

• Returns ModPackManifestEditor

getAuthor

• getAuthor(): string

• Returns string

getDeclaredDirectories

• getDeclaredDirectories(): List<ModPackDeclaredDirectory>

• Returns List<ModPackDeclaredDirectory>

getDescription

• getDescription(): string

• Returns string

getDisplayedName

• getDisplayedName(): string

• Returns string

getPackName

• getPackName(): string

• Returns string

getVersionCode

• getVersionCode(): number

• Returns number

getVersionName

• getVersionName(): string

• Returns string

loadFile

• loadFile(file: File): void

• Parameters

  • file: File

  Returns void

loadInputStream

• loadInputStream(stream: InputStream): void

• Parameters

  • stream: InputStream

  Returns void

loadJson

• loadJson(json: JSONObject): void

• Parameters

  • json: JSONObject

  Returns void

setAuthor

• setAuthor(author: string): void

• Parameters

  • author: string

  Returns void

setDescription

• setDescription(descr: string): void

• Parameters

  • descr: string

  Returns void

setDisplayedName

• setDisplayedName(name: string): void

• Parameters

  • name: string

  Returns void

setPackName

• setPackName(name: string): void

• Parameters

  • name: string

  Returns void

setVersionCode

• setVersionCode(code: number): void

• Parameters

  • code: number

  Returns void

setVersionName

• setVersionName(name: string): void

• Parameters

  • name: string

  Returns void

ModPackManifestEditor

ModPackManifestEditor:

addIfMissing

• addIfMissing(key: string, value: any): ModPackManifestEditor

• Parameters

  • key: string

  • value: any

  Returns ModPackManifestEditor

commit

• commit(): void

• Returns void

put

• put(key: string, value: any): ModPackManifestEditor

• Parameters

  • key: string

  • value: any

  Returns ModPackManifestEditor

ModPackPreferences

ModPackPreferences:

getBoolean

• getBoolean(key: string, fallback: boolean): boolean

• Parameters

  • key: string

  • fallback: boolean

  Returns boolean

getDouble

• getDouble(key: string, fallback: number): number

• Parameters

  • key: string

  • fallback: number

  Returns number

getFile

• getFile(): File

• Returns File

getInt

• getInt(key: string, fallback: number): number

• Parameters

  • key: string

  • fallback: number

  Returns number

getLong

• getLong(key: string, fallback: number): number

• Parameters

  • key: string

  • fallback: number

  Returns number

getModPack

• getModPack(): ModPack

• Returns ModPack

getString

• getString(key: string, fallback: string): string

• Parameters

  • key: string

  • fallback: string

  Returns string

reload

• reload(): ModPackPreferences

• Returns ModPackPreferences

save

• save(): ModPackPreferences

• Returns ModPackPreferences

setBoolean

• setBoolean(key: string, value: boolean): ModPackPreferences

• Parameters

  • key: string

  • value: boolean

  Returns ModPackPreferences

setDouble

• setDouble(key: string, value: number): ModPackPreferences

• Parameters

  • key: string

  • value: number

  Returns ModPackPreferences

setInt

• setInt(key: string, value: number): ModPackPreferences

• Parameters

  • key: string

  • value: number

  Returns ModPackPreferences

setLong

• setLong(key: string, value: number): ModPackPreferences

• Parameters

  • key: string

  • value: number

  Returns ModPackPreferences

setString

• setString(key: string, value: string): ModPackPreferences

• Parameters

  • key: string

  • value: string

  Returns ModPackPreferences

Type Aliases

ModPackDeclaredDirectoryType

ModPackDeclaredDirectoryType: number

Crutch to replace ModPackManifest.DeclaredDirectoryType enum:

• 0 - RESOURCE
• 1 - USER_DATA
• 2 - CONFIG
• 3 - CACHE
• 4 - INVALID

ModPackDirectoryType

ModPackDirectoryType: number

Crutch to replace ModPackDirectory.DirectoryType enum:

• 0 - MODS
• 1 - MOD_ASSETS
• 2 - ENGINE
• 3 - CONFIG
• 4 - CACHE
• 5 - RESOURCE_PACKS
• 6 - BEHAVIOR_PACKS
• 7 - TEXTURE_PACKS
• 8 - CUSTOM