Show / Hide Table of Contents

Class SettlementConfig

Inheritance
System.Object
SettlementConfig
Implements
IController
IViewController
IHasUniversalID
ISettlementConfig
System.ComponentModel.INotifyPropertyChanged
IMigratableConfig
IVersionedConfig
IValidatableConfig
Namespace: Eco.Gameplay.Settlements
Assembly: Eco.Gameplay.dll
Syntax
public class SettlementConfig : Object, IController, IViewController, IHasUniversalID, ISettlementConfig, INotifyPropertyChanged, IMigratableConfig, IVersionedConfig, IValidatableConfig

Constructors

SettlementConfig()

Declaration
public SettlementConfig()

Fields

ArtworkReputationToCultureFormula

Declaration
public LimitMapper.Config ArtworkReputationToCultureFormula
Field Value
Type Description
LimitMapper.Config

ClaimStakeItems

The claim stake item for each settlement type.

Declaration
public List<Type> ClaimStakeItems
Field Value
Type Description
System.Collections.Generic.List<System.Type>

ClaimStakeWorldObjects

The claim stake object for each settlement type.

Declaration
public List<Type> ClaimStakeWorldObjects
Field Value
Type Description
System.Collections.Generic.List<System.Type>

CultureToInfluenceRadius

Declaration
public SettlementConfig.CultureToInfluenceRadiusMapper CultureToInfluenceRadius
Field Value
Type Description
SettlementConfig.CultureToInfluenceRadiusMapper

CultureValueOnResidentialPropertyToHousingValueMultiplierFormula

Declaration
public LimitMapper.Config CultureValueOnResidentialPropertyToHousingValueMultiplierFormula
Field Value
Type Description
LimitMapper.Config

DefaultSuffixes

These names will be appended when starting a town.

Declaration
public static LocString[][] DefaultSuffixes
Field Value
Type Description
LocString[][]

InventorySourceForAnnexationCosts

This type of object associated with a settlement is queried for inventory to perform an annexation.

Declaration
public Type InventorySourceForAnnexationCosts
Field Value
Type Description
System.Type

LeaderNames

Randoms names for leaders, by settlement type.

Declaration
public static LocString[][] LeaderNames
Field Value
Type Description
LocString[][]

PlayerReputationToCultureFormula

Declaration
public LimitMapper.Config PlayerReputationToCultureFormula
Field Value
Type Description
LimitMapper.Config

Properties

ActiveCitizensRequiredtoAnnexRelative

Declaration
[PropertyExplanation]
public float[] ActiveCitizensRequiredtoAnnexRelative { get; set; }
Property Value
Type Description
System.Single[]

AllowOptionToPreventSettlementsFromSeceding

Declaration
[PropertyExplanation]
public bool AllowOptionToPreventSettlementsFromSeceding { get; set; }
Property Value
Type Description
System.Boolean

AnnexationResourceRequirementPerCitizen

Declaration
[PropertyExplanation]
public ResourceRequirement[][] AnnexationResourceRequirementPerCitizen { get; set; }
Property Value
Type Description
ResourceRequirement[][]

AnnexTargetBoostPerAdditionalChildSettlementInUnfoundedSettlementParent

Declaration
[PropertyExplanation]
public float AnnexTargetBoostPerAdditionalChildSettlementInUnfoundedSettlementParent { get; set; }
Property Value
Type Description
System.Single

AnnexTargetBoostPerAdditionalCitizenInUnfoundedSettlementParent

Declaration
[PropertyExplanation]
public float AnnexTargetBoostPerAdditionalCitizenInUnfoundedSettlementParent { get; set; }
Property Value
Type Description
System.Single

AnnexTargetBoostWhenHasUnfoundedSettlementParent

Declaration
[PropertyExplanation]
public float AnnexTargetBoostWhenHasUnfoundedSettlementParent { get; set; }
Property Value
Type Description
System.Single

BaseInfluenceRadiusFoundationMovementAllowedAfterFounding

Declaration
[PropertyExplanation]
public int BaseInfluenceRadiusFoundationMovementAllowedAfterFounding { get; set; }
Property Value
Type Description
System.Int32

BasePlotsOnClaimStake

Declaration
[PropertyExplanation]
public int[] BasePlotsOnClaimStake { get; set; }
Property Value
Type Description
System.Int32[]

BasePlotsOnFoundation

Declaration
[PropertyExplanation]
public int[] BasePlotsOnFoundation { get; set; }
Property Value
Type Description
System.Int32[]

BasePlotsOnHomesteadClaimStake

Declaration
[PropertyExplanation]
public int BasePlotsOnHomesteadClaimStake { get; set; }
Property Value
Type Description
System.Int32

BasePlotsOnOutpostClaimStake

Declaration
[PropertyExplanation]
public int BasePlotsOnOutpostClaimStake { get; set; }
Property Value
Type Description
System.Int32

ClaimStakesPerAbandonedCitizen

Declaration
[PropertyExplanation]
public float[] ClaimStakesPerAbandonedCitizen { get; set; }
Property Value
Type Description
System.Single[]

ClaimStakesPerCitizen

Declaration
[PropertyExplanation]
public float[] ClaimStakesPerCitizen { get; set; }
Property Value
Type Description
System.Single[]

ConfigVersion

Declaration
public int ConfigVersion { get; set; }
Property Value
Type Description
System.Int32

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

CultureAdvantageAbsoluteRequiredToAnnexChildSettlement

Declaration
[PropertyExplanation]
public float[] CultureAdvantageAbsoluteRequiredToAnnexChildSettlement { get; set; }
Property Value
Type Description
System.Single[]

CultureAdvantageAbsoluteRequiredToAnnexSiblingSettlement

Declaration
[PropertyExplanation]
public float[] CultureAdvantageAbsoluteRequiredToAnnexSiblingSettlement { get; set; }
Property Value
Type Description
System.Single[]

CultureAdvantagePercentRequiredToAnnexChildSettlement

Declaration
[PropertyExplanation]
public float[] CultureAdvantagePercentRequiredToAnnexChildSettlement { get; set; }
Property Value
Type Description
System.Single[]

CultureAdvantagePercentRequiredToAnnexSiblingSettlement

Declaration
[PropertyExplanation]
public float[] CultureAdvantagePercentRequiredToAnnexSiblingSettlement { get; set; }
Property Value
Type Description
System.Single[]

CultureDeedLinkPercentRequirement

Declaration
public float CultureDeedLinkPercentRequirement { get; set; }
Property Value
Type Description
System.Single

CultureToInfluenceMappingPerSettlementType

This is linked here so that it can be displayed in the ecopedia details, but its not used directly, the mapper above is called. Use calculator: https://www.desmos.com/calculator/czpu5xcrg3

Declaration
public LimitMapper.Config[] CultureToInfluenceMappingPerSettlementType { get; set; }
Property Value
Type Description
LimitMapper.Config[]

CurrentWorldSizeMultiplier

Declaration
[PropertyExplanation]
public float CurrentWorldSizeMultiplier { get; }
Property Value
Type Description
System.Single

ExtraSettlementPapersToAnnexPerCitizen

Declaration
[PropertyExplanation]
public int[] ExtraSettlementPapersToAnnexPerCitizen { get; set; }
Property Value
Type Description
System.Int32[]

HomesteadMinRequiredPlotCoveragePercentage

Declaration
[PropertyExplanation]
public float HomesteadMinRequiredPlotCoveragePercentage { get; set; }
Property Value
Type Description
System.Single

HomesteadSupportClaimsPerAbandonedCitizen

Declaration
[PropertyExplanation]
public float[] HomesteadSupportClaimsPerAbandonedCitizen { get; set; }
Property Value
Type Description
System.Single[]

HomesteadSupportClaimsPerCitizen

Declaration
[PropertyExplanation]
public float[] HomesteadSupportClaimsPerCitizen { get; set; }
Property Value
Type Description
System.Single[]

HoursBeforeInvalidatingCultureDeed

Declaration
public double HoursBeforeInvalidatingCultureDeed { get; set; }
Property Value
Type Description
System.Double

HoursToResolvePropertyCrisis

Declaration
[PropertyExplanation]
public float[] HoursToResolvePropertyCrisis { get; set; }
Property Value
Type Description
System.Single[]

LastConfigVersion

Declaration
public int LastConfigVersion { get; }
Property Value
Type Description
System.Int32

MaxGivableReputationThroughLaws

Declaration
[PropertyExplanation]
public float[] MaxGivableReputationThroughLaws { get; set; }
Property Value
Type Description
System.Single[]

MaxGivableToSinglePartyPerDay

Declaration
[PropertyExplanation]
public float[] MaxGivableToSinglePartyPerDay { get; set; }
Property Value
Type Description
System.Single[]

MaxGivableToSinglePartyTotal

Declaration
[PropertyExplanation]
public float[] MaxGivableToSinglePartyTotal { get; set; }
Property Value
Type Description
System.Single[]

MaxNumberOfCulturalProperties

Declaration
[PropertyExplanation]
public int[] MaxNumberOfCulturalProperties { get; set; }
Property Value
Type Description
System.Int32[]

MayAnnexSameLevel

Declaration
[PropertyExplanation]
public bool MayAnnexSameLevel { get; set; }
Property Value
Type Description
System.Boolean

MayAnnexSubSettlements

Declaration
[PropertyExplanation]
public bool MayAnnexSubSettlements { get; set; }
Property Value
Type Description
System.Boolean

MinCitizensToFoundSettlement

Declaration
[PropertyExplanation]
public int[] MinCitizensToFoundSettlement { get; set; }
Property Value
Type Description
System.Int32[]

MinCitizensToMaintainSettlement

Declaration
[PropertyExplanation]
public int[] MinCitizensToMaintainSettlement { get; set; }
Property Value
Type Description
System.Int32[]

MinCultureOfFoundationSettlements

Declaration
[PropertyExplanation]
public float[] MinCultureOfFoundationSettlements { get; set; }
Property Value
Type Description
System.Single[]

MinCultureToFoundSettlement

Declaration
[PropertyExplanation]
public float[] MinCultureToFoundSettlement { get; set; }
Property Value
Type Description
System.Single[]

MinCultureToMaintainSettlement

Declaration
[PropertyExplanation]
public float[] MinCultureToMaintainSettlement { get; set; }
Property Value
Type Description
System.Single[]

MinGivableToSinglePartyTotal

Declaration
[PropertyExplanation]
public float[] MinGivableToSinglePartyTotal { get; set; }
Property Value
Type Description
System.Single[]

MinSubSettlementsToFoundSettlement

Declaration
[PropertyExplanation]
public int[] MinSubSettlementsToFoundSettlement { get; set; }
Property Value
Type Description
System.Int32[]

MinSubSettlementsToMaintainSettlement

Declaration
[PropertyExplanation]
public int[] MinSubSettlementsToMaintainSettlement { get; set; }
Property Value
Type Description
System.Int32[]

PercentOfAnnexationResourcesWasted

Declaration
[PropertyExplanation]
public float[] PercentOfAnnexationResourcesWasted { get; set; }
Property Value
Type Description
System.Single[]

PostAnnexationSecessionLockDays

Declaration
[PropertyExplanation]
public float[] PostAnnexationSecessionLockDays { get; set; }
Property Value
Type Description
System.Single[]

ReductionPercentageWhenHomesteadIsAbandoned

Declaration
[PropertyExplanation]
public float ReductionPercentageWhenHomesteadIsAbandoned { get; set; }
Property Value
Type Description
System.Single

ScaleInfluenceBasedOnWorldSize

Declaration
[PropertyExplanation]
public bool ScaleInfluenceBasedOnWorldSize { get; set; }
Property Value
Type Description
System.Boolean

SettlementClaimsPerAbandonedCitizen

Declaration
[PropertyExplanation]
public float[] SettlementClaimsPerAbandonedCitizen { get; set; }
Property Value
Type Description
System.Single[]

SettlementClaimsPerCitizen

Declaration
[PropertyExplanation]
public float[] SettlementClaimsPerCitizen { get; set; }
Property Value
Type Description
System.Single[]

SettlementFoundationBaseInfluence

Declaration
[PropertyExplanation]
public float[] SettlementFoundationBaseInfluence { get; set; }
Property Value
Type Description
System.Single[]

SettlementInfluenceMultiplier

Declaration
[PropertyExplanation]
public float[] SettlementInfluenceMultiplier { get; set; }
Property Value
Type Description
System.Single[]

SettlementMinRequiredPlotCoveragePercentage

Declaration
[PropertyExplanation]
public float SettlementMinRequiredPlotCoveragePercentage { get; set; }
Property Value
Type Description
System.Single

SettlementTypes

Declaration
public List<string> SettlementTypes { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

WeightCultureByPercentOfNeighboringPlotsChildSettlement

Declaration
[PropertyExplanation]
public Range[] WeightCultureByPercentOfNeighboringPlotsChildSettlement { get; set; }
Property Value
Type Description
Range[]

WeightCultureByPercentOfNeighboringPlotsSiblingSettlement

Declaration
[PropertyExplanation]
public Range[] WeightCultureByPercentOfNeighboringPlotsSiblingSettlement { get; set; }
Property Value
Type Description
Range[]

Methods

Migrate(JObject)

Declaration
public void Migrate(JObject json)
Parameters
Type Name Description
Newtonsoft.Json.Linq.JObject json

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

IController
IViewController
IHasUniversalID
ISettlementConfig
System.ComponentModel.INotifyPropertyChanged
IMigratableConfig
IVersionedConfig
IValidatableConfig

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾