CivilopediaTutorial

class CivilopediaTutorial(rawName: String, lines: Array<String>) : SimpleCivilopediaText, INamed

Wrapper for a Tutorial, supports INamed and ICivilopediaText, and already provisions for the display of an ExtraImage on top.

Parameters

rawName

from Tutorial.value, with underscores (this wrapper replaces them with spaces)

lines

Array of lines exactly as stored in a TutorialController.tutorials MapEntry

Constructors

CivilopediaTutorial

fun CivilopediaTutorial(rawName: String, lines: Array<String>)

Functions

assembleCivilopediaText

open fun assembleCivilopediaText(ruleset: Ruleset): ICivilopediaText

Assemble json-supplied lines with automatically generated ones.

equals

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

getCivilopediaTextHeader

open fun getCivilopediaTextHeader(): FormattedLine?

Generate header line from object metadata. Default implementation will take INamed.name and render it in 150% normal font size with an icon from makeLink.

getCivilopediaTextLines

open fun getCivilopediaTextLines(ruleset: Ruleset): List<FormattedLine>

Generate automatic lines from object metadata.

getIconName

open fun getIconName(): String

Overrides Icon used for Civilopedia entry list (where you select the instance) This will still be passed to the category-specific image getter.

getSortGroup

open fun getSortGroup(ruleset: Ruleset): Int

Overrides alphabetical sorting in Civilopedia

hashCode

open fun hashCode(): Int

makeLink

open override fun makeLink(): String

Create the correct string for a Civilopedia link

renderCivilopediaText

open fun renderCivilopediaText(labelWidth: Float, linkAction: (id: String) -> Unit? = null): Table

Build a Gdx Table showing our formatted content.

toString

open fun toString(): String

Properties

civilopediaText

open override var civilopediaText: List<FormattedLine>

List of strings supporting simple formatting rules that CivilopediaScreen can render. May later be merged with automatic lines generated by the deriving class through overridden getCivilopediaTextHeader and/or getCivilopediaTextLines methods.

name

open override var name: String

Sources

jvm source