BaseUnit

class BaseUnit : RulesetObject, INonPerpetualConstruction

This is the basic info of the units, as specified in Units.json, in contrast to MapUnit, which is a specific unit of a certain type that appears on the map

Constructors

BaseUnit

fun BaseUnit()

Functions

addConstructionBonuses

fun addConstructionBonuses(unit: MapUnit, cityConstructions: CityConstructions)

assembleCivilopediaText

open fun assembleCivilopediaText(ruleset: Ruleset): ICivilopediaText

Assemble json-supplied lines with automatically generated ones.

canBePurchasedWithAnyStat

open fun canBePurchasedWithAnyStat(cityInfo: CityInfo): Boolean

canBePurchasedWithStat

open override fun canBePurchasedWithStat(cityInfo: CityInfo?, stat: Stat): Boolean

equals

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

evaluateForce

private fun evaluateForce()

getBaseBuyCost

open override fun getBaseBuyCost(cityInfo: CityInfo, stat: Stat): Int?

getBaseGoldCost

open fun getBaseGoldCost(civInfo: CivilizationInfo): Double

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 override fun getCivilopediaTextLines(ruleset: Ruleset): List<FormattedLine>

Generate automatic lines from object metadata.

getCostForConstructionsIncreasingInPrice

open fun getCostForConstructionsIncreasingInPrice(baseCost: Int, increaseCost: Int, previouslyBought: Int): Int

getDescription

fun getDescription(): String

Generate description as multi-line string for Nation description addUniqueUnitsText and CityScreen addSelectedConstructionTable

getDirectUpgradeUnit

fun getDirectUpgradeUnit(civInfo: CivilizationInfo): BaseUnit

getDisbandGold

fun getDisbandGold(civInfo: CivilizationInfo): Int

getForceEvaluation

fun getForceEvaluation(): Int

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.

getMapUnit

fun getMapUnit(civInfo: CivilizationInfo): MapUnit

getMatchingUniques

open fun getMatchingUniques(uniqueType: UniqueType, stateForConditionals: StateForConditionals? = null): Sequence<Unique>

open fun getMatchingUniques(uniqueTemplate: String, stateForConditionals: StateForConditionals? = null): Sequence<Unique>

getProductionCost

open override fun getProductionCost(civInfo: CivilizationInfo): Int

getRejectionReasons

open override fun getRejectionReasons(cityConstructions: CityConstructions): RejectionReasons

fun getRejectionReasons(civInfo: CivilizationInfo): RejectionReasons

getReplacedUnit

fun getReplacedUnit(ruleset: Ruleset): BaseUnit

getResourceRequirements

open override fun getResourceRequirements(): HashMap<String, Int>

getShortDescription

fun getShortDescription(): String

getSortGroup

open fun getSortGroup(ruleset: Ruleset): Int

Overrides alphabetical sorting in Civilopedia

getStatBuyCost

open override fun getStatBuyCost(cityInfo: CityInfo, stat: Stat): Int?

getType

fun getType(): UnitType

getUniqueTarget

open override fun getUniqueTarget(): UniqueTarget

Technically not currently needed, since the unique target can be retrieved from every unique in the uniqueObjects, But making this a function is relevant for future "unify Unciv object" plans ;)

hashCode

open fun hashCode(): Int

hasUnique

open fun hasUnique(uniqueType: UniqueType, stateForConditionals: StateForConditionals? = null): Boolean

open fun hasUnique(uniqueTemplate: String, stateForConditionals: StateForConditionals? = null): Boolean

isAirUnit

fun isAirUnit(): Boolean

isBuildable

open override fun isBuildable(cityConstructions: CityConstructions): Boolean

fun isBuildable(civInfo: CivilizationInfo): Boolean

isBuildableIgnoringTechs

fun isBuildableIgnoringTechs(civInfo: CivilizationInfo): Boolean

isCivilian

fun isCivilian(): Boolean

isGreatPerson

fun isGreatPerson(): Boolean

isLandUnit

fun isLandUnit(): Boolean

isMelee

fun isMelee(): Boolean

isMilitary

fun isMilitary(): Boolean

isNuclearWeapon

fun isNuclearWeapon(): Boolean

isProbablySiegeUnit

fun isProbablySiegeUnit(): Boolean

isPurchasable

open fun isPurchasable(cityConstructions: CityConstructions): Boolean

Checks if the construction should be purchasable, not whether it can be bought with a stat at all

isRanged

fun isRanged(): Boolean

isWaterUnit

fun isWaterUnit(): Boolean

makeLink

open override fun makeLink(): String

Create the correct string for a Civilopedia link

matchesFilter

fun matchesFilter(filter: String): Boolean

movesLikeAirUnits

fun movesLikeAirUnits(): Boolean

postBuildEvent

open override fun postBuildEvent(cityConstructions: CityConstructions, boughtWith: Stat?): Boolean

renderCivilopediaText

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

Build a Gdx Table showing our formatted content.

requiresResource

open override fun requiresResource(resource: String): Boolean

shouldBeDisplayed

open override fun shouldBeDisplayed(cityConstructions: CityConstructions): Boolean

toString

open override fun toString(): String

Properties

attackSound

var attackSound: String? = null

cachedForceEvaluation

@Transient

var cachedForceEvaluation: Int

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.

cost

var cost: Int = 0

hurryCostModifier

open override var hurryCostModifier: Int = 0

interceptRange

var interceptRange: Int = 0

movement

var movement: Int = 0

name

open lateinit override var name: String

obsoleteTech

var obsoleteTech: String? = null