Class SettlementFoundationComponent

Inheritance
System.Object
WorldObjectComponent
SettlementFoundationComponent
Inherited Members
Namespace: Eco.Gameplay.Settlements.Components
Assembly: Eco.Gameplay.dll
Syntax
public sealed class SettlementFoundationComponent : WorldObjectComponent, ILinkable, IOwned, IController, IViewController, IHasUniversalID, IHasSerializableID, IRPCAuthChecks, INotifyPropertyChanged, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasInteractions, IPostAddListenerComponent, IClaimStakeComponent, IPickupConfirmationComponent, IHasBaseInfluence, IInventoryWorldObjectComponent, IPermanentDestroyHandler, IHostsObjects

Constructors

SettlementFoundationComponent()

Declaration
public SettlementFoundationComponent()

Fields

FoundedSettlementInited

Declaration
public Action FoundedSettlementInited
Field Value
Type Description
System.Action

SettlementFoundedEvent

Declaration
public static ThreadSafeAction<Settlement> SettlementFoundedEvent
Field Value
Type Description
ThreadSafeAction<Settlement>

SettlementPictureChangeEvent

Declaration
public static ThreadSafeAction<Settlement> SettlementPictureChangeEvent
Field Value
Type Description
ThreadSafeAction<Settlement>

Properties

AdvertisementToNewPeopleEnteringWorld

Declaration
public string AdvertisementToNewPeopleEnteringWorld { get; set; }
Property Value
Type Description
System.String

CanFound

Declaration
public bool CanFound { get; }
Property Value
Type Description
System.Boolean

ComponentTabName

Declaration
public override LocString ComponentTabName { get; }
Property Value
Type Description
LocString
Overrides

Enabled

Declaration
public override bool Enabled { get; }
Property Value
Type Description
System.Boolean
Overrides

InfluenceColor

Declaration
public Color InfluenceColor { get; set; }
Property Value
Type Description
Color

MustHaveChildren

Declaration
public bool MustHaveChildren { get; set; }
Property Value
Type Description
System.Boolean

NotFounded

Declaration
public bool NotFounded { get; }
Property Value
Type Description
System.Boolean

PictureSlot

Declaration
public LimitedInventory PictureSlot { get; set; }
Property Value
Type Description
LimitedInventory

Settlement

Declaration
public Settlement Settlement { get; }
Property Value
Type Description
Settlement

SettlementNameUponFounding

Declaration
public string SettlementNameUponFounding { get; set; }
Property Value
Type Description
System.String

SettlementType

Declaration
public SettlementType SettlementType { get; }
Property Value
Type Description
SettlementType

ShowFoundButton

Declaration
public bool ShowFoundButton { get; }
Property Value
Type Description
System.Boolean

ShowPicture

Declaration
public bool ShowPicture { get; }
Property Value
Type Description
System.Boolean

Title

Declaration
public LocString Title { get; }
Property Value
Type Description
LocString

TitlePlate

Declaration
public LocString TitlePlate { get; set; }
Property Value
Type Description
LocString

Methods

AdminMode(Player)

Declaration
public bool AdminMode(Player player)
Parameters
Type Name Description
Player player
Returns
Type Description
System.Boolean

Destroy()

Declaration
public override void Destroy()
Overrides

DoFounding(Election)

Helper that forces founding of the settlement. Called directly when founding via ratification. Takes an optional param for an election that founded it, stored for posterity.

Declaration
public void DoFounding(Election foundingElection = null)
Parameters
Type Name Description
Election foundingElection

FoundationPictureDescription()

Get a Settlement picture description.

Declaration
public LocString FoundationPictureDescription()
Returns
Type Description
LocString

FoundSettlement(User)

Declaration
public void FoundSettlement(User user)
Parameters
Type Name Description
User user

FoundSettlementTitle()

Declaration
public string FoundSettlementTitle()
Returns
Type Description
System.String

HasDiplomaticPrivilege(User)

Declaration
public bool HasDiplomaticPrivilege(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean

Initialize()

Declaration
public override void Initialize()
Overrides

PostAdd()

Declaration
public void PostAdd()

Explicit Interface Implementations

IHasBaseInfluence.BaseInfluence

Declaration
float IHasBaseInfluence.BaseInfluence { get; }
Returns
Type Description
System.Single

IInventoryWorldObjectComponent.Inventory

Declaration
Inventory IInventoryWorldObjectComponent.Inventory { get; }
Returns
Type Description
Inventory

IPickupConfirmationComponent.CanPickup()

Declaration
Result IPickupConfirmationComponent.CanPickup()
Returns
Type Description
Result

IHostsObjects.UpdateHostedStatus()

Declaration
void IHostsObjects.UpdateHostedStatus()

IClaimStakeComponent.DeedChanged()

Declaration
void IClaimStakeComponent.DeedChanged()

IClaimStakeComponent.OwningSettlement

Declaration
Settlement IClaimStakeComponent.OwningSettlement { get; }
Returns
Type Description
Settlement

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods