Policy

open class Policy : RulesetObject

Types

Companion
Link copied to clipboard
object Companion
PolicyBranchType
Link copied to clipboard
enum PolicyBranchType : Enum<Policy.PolicyBranchType>

Indicates whether a Policy is a PolicyBranch starting policy, a normal one, or the branch completion

Functions

assembleCivilopediaText
Link copied to clipboard
open fun assembleCivilopediaText(ruleset: Ruleset): ICivilopediaText

Assemble json-supplied lines with automatically generated ones.

equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
getCivilopediaTextHeader
Link copied to clipboard
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
Link copied to clipboard
open override fun getCivilopediaTextLines(ruleset: Ruleset): List<FormattedLine>

Generate automatic lines from object metadata.

getDescription
Link copied to clipboard
fun getDescription(): String

Used in PolicyPickerScreen to display Policy properties

getIconName
Link copied to clipboard
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.

getMatchingUniques
Link copied to clipboard
open fun getMatchingUniques(uniqueType: UniqueType, stateForConditionals: StateForConditionals? = null): Sequence<Unique>
open fun getMatchingUniques(uniqueTemplate: String, stateForConditionals: StateForConditionals? = null): Sequence<Unique>
getSortGroup
Link copied to clipboard
open override fun getSortGroup(ruleset: Ruleset): Int

Overrides alphabetical sorting in Civilopedia

getUniqueTarget
Link copied to clipboard
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
Link copied to clipboard
open fun hashCode(): Int
hasUnique
Link copied to clipboard
open fun hasUnique(uniqueType: UniqueType, stateForConditionals: StateForConditionals? = null): Boolean
open fun hasUnique(uniqueTemplate: String, stateForConditionals: StateForConditionals? = null): Boolean
makeLink
Link copied to clipboard
open override fun makeLink(): String

Create the correct string for a Civilopedia link

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

Build a Gdx Table showing our formattedcontent.

toString
Link copied to clipboard
open override fun toString(): String

Properties

branch
Link copied to clipboard
lateinit var branch: PolicyBranch
civilopediaText
Link copied to clipboard
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.

column
Link copied to clipboard
var column: Int = 0
name
Link copied to clipboard
open lateinit override var name: String
policyBranchType
Link copied to clipboard
val policyBranchType: Policy.PolicyBranchType

Indicates whether this Policy is a PolicyBranch starting policy, a normal one, or the branch completion

requires
Link copied to clipboard
var requires: ArrayList<String>? = null
row
Link copied to clipboard
var row: Int = 0
uniqueObjects
Link copied to clipboard
open override val uniqueObjects: List<Unique>
uniques
Link copied to clipboard
open override var uniques: ArrayList<String>

Inheritors

PolicyBranch
Link copied to clipboard

Sources

jvm source
Link copied to clipboard