Stats

open class Stats(production: Float, food: Float, gold: Float, science: Float, culture: Float, happiness: Float, faith: Float) : Iterable<Stats.StatValuePair>

A container for the seven basic "currencies" in Unciv, Mutable, allowing for easy merging of sources and applying bonuses.

Supports e.g. for ((key,value) in <Stats>) - the iterator will skip zero values automatically.

Also possible: <Stats>.values.sum() and similar aggregates over a Sequence.

Constructors

Stats

fun Stats(production: Float = 0f, food: Float = 0f, gold: Float = 0f, science: Float = 0f, culture: Float = 0f, happiness: Float = 0f, faith: Float = 0f)

Types

Companion

object Companion

StatValuePair

data class StatValuePair(key: Stat, value: Float)

Represents one key/value pair returned by the iterator

Functions

add

fun add(other: Stats)

Adds each value of another Stats instance to this one in place

fun add(stat: Stat, value: Float): Stats

Adds the value parameter to the instance value specified by stat in place

asSequence

fun asSequence(): Sequence<Stats.StatValuePair>

Enables iteration over the non-zero Stat/value pairs. Explicit use unnecessary - Stats is iterable directly.

clear

fun clear()

Reset all values to zero (in place)

clone

fun clone(): Stats

div

operator fun div(number: Float): Stats

equals

fun equals(otherStats: Stats): Boolean

Compares two instances. Not callable via ==.

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

forEach

open fun forEach(p0: Consumer<in Stats.StatValuePair>)

get

operator fun get(stat: Stat): Float

Indexed read of a value for a given Stat, e.g. this.gold == this[Stat.Gold]

hashCode

open fun hashCode(): Int

isEmpty

fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<Stats.StatValuePair>

Returns an iterator over the elements of this object, wrapped as StatValuePairs

plus

operator fun plus(stats: Stats): Stats

set

operator fun set(stat: Stat, value: Float)

Indexed write of a value for a given Stat, e.g. this.gold += 1f is equivalent to this[Stat.Gold] += 1f

spliterator

open fun spliterator(): Spliterator<Stats.StatValuePair>

times

operator fun times(number: Float): Stats

operator fun times(number: Int): Stats

timesInPlace

fun timesInPlace(number: Float)

Multiplies each value of this instance by number in place

toString

open override fun toString(): String

Not only a debug helper. It returns a string representing the content, already translated.

toStringWithDecimals

fun toStringWithDecimals(): String

Properties

culture

var culture: Float = 0f

faith

var faith: Float = 0f

food

var food: Float = 0f

gold

var gold: Float = 0f

happiness

var happiness: Float = 0f

mapView

private val mapView: Map<Stat, KMutableProperty0<Float>>

production

var production: Float = 0f

science

var science: Float = 0f

values

val values: Sequence<Float>

Enables aggregates over the values, never empty

Inheritors

NamedStats

Sources

jvm source