Class SettlementFactory

Creating and destroying settlements.

Inheritance

System.Object

SettlementFactory

Namespace: Eco.Gameplay.Settlements

Assembly: Eco.Gameplay.dll

Syntax

public static class SettlementFactory : Object

Methods

ApplyDefaultSettlementSetup(Settlement, Boolean, Boolean, Boolean, Boolean)

Declaration

public static LocString ApplyDefaultSettlementSetup(Settlement settlement, bool createImmigrationPolicy, bool createLeaderTitle, bool createConstitution, bool resetAll = false)

Parameters

Type	Name	Description
Settlement	settlement
System.Boolean	createImmigrationPolicy
System.Boolean	createLeaderTitle
System.Boolean	createConstitution
System.Boolean	resetAll

Returns

Type	Description
LocString

CreateSettlement(WorldObject, User, SettlementType, Demographic, ElectionProcess, Boolean, Boolean, Boolean, String, Boolean)

Create a brand new settlement and fill it in, and create extra parts like leaders and immigration.

Declaration

public static Settlement CreateSettlement(WorldObject hostObj, User creator, SettlementType settlementType, Demographic existingDemographic, ElectionProcess existingElectionProcess, bool createImmigrationPolicy = true, bool createLeaderTitle = true, bool createConstitution = true, string name = null, bool addCurrentSettlementsAsChildAndParent = true)

Parameters

Type	Name	Description
WorldObject	hostObj
User	creator
SettlementType	settlementType
Demographic	existingDemographic
ElectionProcess	existingElectionProcess
System.Boolean	createImmigrationPolicy
System.Boolean	createLeaderTitle
System.Boolean	createConstitution
System.String	name
System.Boolean	addCurrentSettlementsAsChildAndParent

Returns

Type	Description
Settlement