Class SettlementFoundationItem<T>

Base class for items that claim a settlement. Contains functions for defining how property can be claimed without overlapping with existing settlements or other plots. Manages the display of that available land on the client.

Inheritance
System.Object
ItemLinkable
ItemRepresentation
Item
DurabilityItem
WorldObjectItem
WorldObjectItem<T>
SettlementFoundationItem<T>
Inherited Members
Namespace: Eco.Gameplay.Settlements
Assembly: Eco.Gameplay.dll
Syntax
[RequireComponent]
public abstract class SettlementFoundationItem<T> : WorldObjectItem<T>, IItem, ILinkableParameterized<LinkConfig>, ILinkable, IHasIcon, INotifyPropertyChanged, IPlaceableItem, IController, IViewController, IHasUniversalID where T : WorldObject
Type Parameters
Name Description
T

Constructors

SettlementFoundationItem()

Declaration
protected SettlementFoundationItem()

Properties

SettlementType

Declaration
protected abstract SettlementType SettlementType { get; }
Property Value
Type Description
SettlementType

Methods

CanMove(Player, Vector3i, Quaternion, INetObject)

This will check whether this item can be moved by the specified player to the specified position or not. If moving the settlement foundation to the specified position would lead to some citizen or children changes, a confirmation popup will be shown up to the player.

Declaration
protected override Task<bool> CanMove(Player player, Vector3i pos, Quaternion rotation, INetObject woNetObject)
Parameters
Type Name Description
Player player
Vector3i pos
Quaternion rotation
INetObject woNetObject
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides

CanPlaceObject(Player, Vector3, Quaternion)

Declaration
public override Task<bool> CanPlaceObject(Player player, Vector3 worldPos, Quaternion rotation)
Parameters
Type Name Description
Player player
System.Numerics.Vector3 worldPos
Quaternion rotation
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides

OnDeselected(Player)

Declaration
public override void OnDeselected(Player player)
Parameters
Type Name Description
Player player
Overrides

OnSelected(Player)

Declaration
public override void OnSelected(Player player)
Parameters
Type Name Description
Player player
Overrides

PlacingObject(GameActionPack, Player, ItemStack, Vector3, Quaternion)

Declaration
public override Task PlacingObject(GameActionPack pack, Player player, ItemStack containingStack, Vector3 pos, Quaternion rotation)
Parameters
Type Name Description
GameActionPack pack
Player player
ItemStack containingStack
System.Numerics.Vector3 pos
Quaternion rotation
Returns
Type Description
System.Threading.Tasks.Task
Overrides

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods