Class PlotsComponent

Allows claiming connected plots to where the parent is placed. Adding claim papers will charge it up. The deed map lets you make the claims.

Inheritance
System.Object
WorldObjectComponent
StorageComponent
InteractableStorage
PlotsComponent
Inherited Members
Namespace: Eco.Gameplay.Components
Assembly: Eco.Gameplay.dll
Syntax
public class PlotsComponent : InteractableStorage, ILinkable, IOwned, IController, IViewController, IHasUniversalID, IHasSerializableID, IRPCAuthChecks, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasInteractions, IInventoryWorldObjectComponent, IPermanentDestroyHandler, ICanOverrideAuth, IHasEnvVars, INotifyPropertyChanged, IPickupConfirmationComponent, IClaimStakeComponent

Constructors

PlotsComponent()

Declaration
public PlotsComponent()

Fields

AllowedSlots

Declaration
public int AllowedSlots
Field Value
Type Description
System.Int32

GetModdedBaseClaims

Declaration
public Func<int> GetModdedBaseClaims
Field Value
Type Description
System.Func<System.Int32>

OnChanged

Declaration
public readonly ThreadSafeAction OnChanged
Field Value
Type Description
ThreadSafeAction

Properties

Availability

Declaration
public override WorldObjectComponentClientAvailability Availability { get; }
Property Value
Type Description
WorldObjectComponentClientAvailability
Overrides

ClaimPapersInventory

Declaration
public AuthorizationInventory ClaimPapersInventory { get; }
Property Value
Type Description
AuthorizationInventory

Description

Declaration
[NewTooltip]
public LocString Description { get; }
Property Value
Type Description
LocString

DestroyDeedWithObject

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

IconName

Declaration
public override string IconName { get; }
Property Value
Type Description
System.String
Overrides

Inventory

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

OverburdenedPlotsValidityTime

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

ResizeDeedWhenNecessary

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

Methods

BaseClaims()

Counts how many base claims, based on whether this stake is from a homestead or settlement.

Declaration
public int BaseClaims()
Returns
Type Description
System.Int32

Destroy()

Declaration
public override void Destroy()
Overrides

GetComponentPickupConfirmation()

Declaration
public LocString GetComponentPickupConfirmation()
Returns
Type Description
LocString

Initialize()

Declaration
public override void Initialize()
Overrides

ReturnPapers(Settlement, Type)

Move items back to the owner, unless theyre abandoned, in which case we return them to the settlement that created them. Accepts a settlement that it limits to (null for all). Returns a description of where they were sent to.

Declaration
public (LocString, int) ReturnPapers(Settlement onlyForSettlement, Type limitToType = null)
Parameters
Type Name Description
Settlement onlyForSettlement
System.Type limitToType
Returns
Type Description
System.ValueTuple<LocString, System.Int32>

TryPickup(Player, InventoryChangeSet, Inventory, Boolean)

Declaration
public override InventoryMoveResult TryPickup(Player player, InventoryChangeSet playerInvChanges, Inventory targetInventory, bool force)
Parameters
Type Name Description
Player player
InventoryChangeSet playerInvChanges
Inventory targetInventory
System.Boolean force
Returns
Type Description
InventoryMoveResult
Overrides

TryResolveOverburdened(Boolean)

This will take care of randomly removing plots from this deed until the number of claimed plots become equal to the number allowed plots.

Declaration
public bool TryResolveOverburdened(bool force)
Parameters
Type Name Description
System.Boolean force
Returns
Type Description
System.Boolean

UpdateDescription()

Declaration
public void UpdateDescription()

Explicit Interface Implementations

IClaimStakeComponent.DeedChanged()

Declaration
void IClaimStakeComponent.DeedChanged()

IClaimStakeComponent.OwningSettlement

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

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods