ModManagementScreen

class ModManagementScreen(previousInstalledMods: HashMap<String, ModUIData>?, previousOnlineMods: HashMap<String, ModUIData>?) : PickerScreen

The Mod Management Screen - called only from MainMenuScreen

Parameters

previousOnlineMods

cached online mod list, if supplied and not empty, it will be displayed as is and no online query will be run. Used for resize.

Constructors

ModManagementScreen

fun ModManagementScreen(previousInstalledMods: HashMap<String, ModUIData>? = null, previousOnlineMods: HashMap<String, ModUIData>? = null)

Types

Companion

object Companion

Functions

addModInfoToActionTable

private fun addModInfoToActionTable(repo: Github.Repo)

private fun addModInfoToActionTable(modName: String, modOptions: ModOptions)

Recreate the information part of the right-hand column

private fun addModInfoToActionTable(modName: String, repoUrl: String, updatedAt: String, author: String, modSize: Int)

deleteMod

private fun deleteMod(modName: String)

Delete a Mod, refresh ruleset cache and update installed mod table

displayTutorial

fun displayTutorial(tutorial: Tutorial, test: () -> Boolean? = null)

dispose

open override fun dispose()

downloadMod

private fun downloadMod(repo: Github.Repo, postAction: () -> Unit = {})

Download and install a mod in the background, called both from the right-bottom button and the URL entry popup

equals

open operator fun equals(other: Any?): Boolean

getDownloadFromUrlButton

private fun getDownloadFromUrlButton(): TextButton

Create the special "Download from URL" button

hashCode

open fun hashCode(): Int

hide

open override fun hide()

initLandscape

private fun initLandscape()

initPortrait

private fun initPortrait()

installedButtonAction

private fun installedButtonAction(mod: ModUIData)

isCrampedPortrait

fun isCrampedPortrait(): Boolean

isNarrowerThan4to3

fun isNarrowerThan4to3(): Boolean

isPortrait

fun isPortrait(): Boolean

onBackButtonClicked

fun onBackButtonClicked(action: () -> Unit)

onlineButtonAction

private fun onlineButtonAction(repo: Github.Repo, button: Button)

Used as onClick handler for the online Mod list buttons

openOptionsPopup

fun openOptionsPopup()

pause

open override fun pause()

pick

protected fun pick(rightButtonText: String)

Sets the text of the rightSideButton and enables it if it's the player's turn

refreshInstalledModTable

internal fun refreshInstalledModTable()

Rebuild the left-hand column containing all installed mods

refreshModActions

private fun refreshModActions(mod: Ruleset)

Rebuild the right-hand column for clicks on installed mods Display single mod metadata, offer additional actions (delete is elsewhere)

refreshOnlineModTable

internal fun refreshOnlineModTable()

reloadOnlineMods

private fun reloadOnlineMods()

removeRightSideClickListeners

fun removeRightSideClickListeners()

Remove listeners from rightSideButton to prepare giving it a new onClick

render

open override fun render(delta: Float)

resize

open override fun resize(width: Int, height: Int)

resume

open override fun resume()

rewriteModOptions

private fun rewriteModOptions(repo: Github.Repo, modFolder: FileHandle)

Rewrite modOptions file for a mod we just installed to include metadata we got from the GitHub api

setDefaultCloseAction

fun setDefaultCloseAction(previousScreen: BaseScreen? = null)

Initializes the Close button's action (and the Back/ESC handler) to return to the previousScreen if specified, or else to the world screen.

setRightSideButtonEnabled

fun setRightSideButtonEnabled(enabled: Boolean)

Enables the rightSideButton. See pick for a way to set the text.

show

open override fun show()

showModDescription

private fun showModDescription(modName: String)

syncInstalledSelected

private fun syncInstalledSelected(name: String, button: Button)

syncOnlineSelected

private fun syncOnlineSelected(name: String, button: Button)

syncSelected

private fun syncSelected(name: String, button: Button, index: HashMap<String, ModUIData>, scroll: ScrollPane)

toString

open fun toString(): String

tryDownloadPage

private fun tryDownloadPage(pageNum: Int)

background worker: querying GitHub for Mods (repos with 'unciv-mod' in its topics)

unMarkUpdatedMod

private fun unMarkUpdatedMod(name: String)

Remove the visual indicators for an 'updated' mod after re-downloading it. (" - Updated" on the button text in the online mod list and the icon beside the installed mod's button) It should be up to date now (unless the repo's date is in the future relative to system time)

Properties

amountPerPage

val amountPerPage: Int = 30

bottomTable

protected var bottomTable: Table

Holds the Close button, a description label and an action button

closeButton

protected var closeButton: TextButton

The close button on the lower left of bottomTable, see setDefaultCloseAction

deprecationCell

private val deprecationCell: Cell<WrappableLabel>

deprecationLabel

private val deprecationLabel: WrappableLabel

descriptionLabel

protected var descriptionLabel: Label

A scrollable wrapped Label you can use to show descriptions in the bottomTable, starts empty

downloadModCount

private var downloadModCount: Int = 0

downloadTable

private val downloadTable: Table

game

val game: UncivGame

installedExpanderTab

private var installedExpanderTab: ExpanderTab? = null

installedHeaderLabel

private var installedHeaderLabel: Label? = null

installedModInfo

private val installedModInfo: HashMap<String, ModUIData>

keyPressDispatcher

val keyPressDispatcher: KeyPressDispatcher

lastSelectedButton

private var lastSelectedButton: Button? = null

lastSyncMarkedButton

private var lastSyncMarkedButton: Button? = null

maxBottomTableHeight

private val maxBottomTableHeight: Float = 150f

modActionTable

private val modActionTable: Table

modDescriptionLabel

private val modDescriptionLabel: WrappableLabel

modTable

private val modTable: Table

onlineExpanderTab

private var onlineExpanderTab: ExpanderTab? = null

onlineHeaderLabel

private var onlineHeaderLabel: Label? = null

onlineModInfo

private val onlineModInfo: HashMap<String, ModUIData>

onlineScrollCurrentY

private var onlineScrollCurrentY: Float

optionsManager

private val optionsManager: ModManagementOptions

rightSideButton

protected var rightSideButton: TextButton

A button on the lower right of bottomTable you can use for a "OK"-type action, starts disabled

rightSideGroup

protected var rightSideGroup: VerticalGroup

A wrapper containing rightSideButton. You can add buttons, they will be arranged vertically

runningSearchThread

private var runningSearchThread: Thread? = null

screenSplit

private val screenSplit: Float = 0.85f

scrollInstalledMods

private val scrollInstalledMods: AutoScrollPane

scrollOnlineMods

private val scrollOnlineMods: AutoScrollPane

scrollPane

protected var scrollPane: AutoScrollPane

A ScrollPane scrolling topTable, disabled by the disableScroll parameter

selectedAuthor

private var selectedAuthor: String

selectedModName

private var selectedModName: String

splitPane

protected var splitPane: SplitPane

A fixed SplitPane holds scrollPane and bottomTable

stage

val stage: Stage

stopBackgroundTasks

private var stopBackgroundTasks: Boolean = false

topTable

protected var topTable: Table

The table displaying the choices from which to pick (usually). Also the element which most of the screen real estate is devoted to displaying.

tutorialController

protected val tutorialController: TutorialController

Sources

jvm source