Class SettlementClaimStakeComponent

A component for claim stakes that can specify a settlement as their parent. Not used for settlements being parented to other settlements.

Inheritance
System.Object
WorldObjectComponent
SettlementClaimStakeComponent
Inherited Members
Namespace: Eco.Gameplay.Settlements.Components
Assembly: Eco.Gameplay.dll
Syntax
public class SettlementClaimStakeComponent : WorldObjectComponent, ILinkable, IOwned, IController, IViewController, IHasUniversalID, IHasSerializableID, IRPCAuthChecks, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasInteractions, INotifyPropertyChanged, IClaimStakeComponent

Constructors

SettlementClaimStakeComponent()

Declaration
public SettlementClaimStakeComponent()

Fields

SettlementNameChangedEvent

Declaration
public static ThreadSafeAction<SettlementClaimStakeComponent> SettlementNameChangedEvent
Field Value
Type Description
ThreadSafeAction<SettlementClaimStakeComponent>

Properties

Description

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

InfluencingSettlement

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

OwningSettlement

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

Methods

Destroy()

Declaration
public override void Destroy()
Overrides

Initialize()

Declaration
public override void Initialize()
Overrides

OnCreate()

Declaration
public override void OnCreate()
Overrides

SetInfluencingSettlement(Settlement)

We update the lowest influencing settlement by also making sure to notify the settlement that's influencing it.

Declaration
public void SetInfluencingSettlement(Settlement newSettlement)
Parameters
Type Name Description
Settlement newSettlement

StakeOwnerUpdated()

Update the settlement that owns this stake.

Declaration
public void StakeOwnerUpdated()

Explicit Interface Implementations

IClaimStakeComponent.DeedChanged()

Must be called by the placing thing after the deed is all setup.

Declaration
void IClaimStakeComponent.DeedChanged()

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods