Show / Hide Table of Contents

Class SettlementClaimStakeItem

A settlement claim stake item is different than a homestead one in that it is locked to a given settlement permanently. Also will make the store match them to the required settlement in the config options, so you can buy/sell and maintain the settlement associated.

Inheritance
System.Object
ItemLinkable
ItemRepresentation
Item
DurabilityItem
WorldObjectItem
ClaimStakeItemBase
SettlementClaimStakeItem
Implements
IItem
ILinkableParameterized<LinkConfig>
ILinkable
IHasIcon
IPlaceableItem
ISettlementAssociated
IController
IViewController
IHasUniversalID
System.ComponentModel.INotifyPropertyChanged
Inherited Members
ClaimStakeItemBase.OnDeselected(Player)
ClaimStakeItemBase.CanPlaceObject(Player, Vector3, Quaternion)
ClaimStakeItemBase.PlacingObject(GameActionPack, Player, ItemStack, Vector3, Quaternion)
ClaimStakeItemBase.CanClaim(Player, Vector3i, Boolean)
ClaimStakeItemBase.GetOccupancyContext
WorldObjectItem.AllowWaterPlacement
WorldObjectItem.Initialize()
WorldObjectItem.GetCreatingItemTemplateFromType(Type)
WorldObjectItem.MakeItemFromWorldObjectType(Type)
WorldObjectItem.GetAllObjectsTooltip(Player)
WorldObjectItem.GetBlockTypesForDirection(Vector3i)
WorldObjectItem.GetDurability()
WorldObjectItem.SetDurability(Single)
WorldObjectItem.Place(Player, Vector3, Quaternion, Int32)
WorldObjectItem.CanMove(Player, Vector3i, Quaternion, INetObject)
WorldObjectItem.Move(Player, Vector3i, Quaternion, INetObject)
WorldObjectItem.GetMoveInfo(Player, INetObject)
WorldObjectItem.OnPostWorldObjectPlaced(WorldObject)
WorldObjectItem.HomeValue
WorldObjectItem.ShouldCreate
WorldObjectItem.ShowLocationsInWorld
WorldObjectItem.Durability
WorldObjectItem.OccupancyContext
WorldObjectItem.Blockers
DurabilityItem.GetQualityGroup()
DurabilityItem.Merge(Item, Int32, Int32, Boolean)
DurabilityItem.OriginalMaxDurability
DurabilityItem.Decays
DurabilityItem.DurabilityPercent
DurabilityItem.PercentBrokenFromOriginal
DurabilityItem.DisplayDurability
DurabilityItem.Broken
DurabilityItem.BrokenDescription
DurabilityItem.DefaultMinRequiredDurabilityInTradeOffers
DurabilityItem.PropertyChanged
Item.ItemsInitialized
Item.RepresentsItemType(Type)
Item.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)
Item.ClearMaxStackSizeCache()
Item.GetMaxStackSize(Type)
Item.ToString()
Item.UnsubscribeUnique()
Item.OnUsed(Player, ItemStack)
Item.OnLeftClicked(Player, ItemStack)
Item.Get(IRepresentsItem)
Item.Get(Int32)
Item.Get<T>()
Item.Get(Type)
Item.Get(String)
Item.ShowName(Type, Single)
Item.ShowName(Type, Int32)
Item.ShowName<T>(Int32)
Item.NameAndNum(Type, Int32)
Item.GetSkillbookForSkillType(Type)
Item.CreatingItem(Type)
Item.GetCreatedObj(Type)
Item.TypeIsUnique(Type)
Item.GetNonUniqueOrClone(Int32)
Item.GetNonUniqueOrClone(Type)
Item.NameAndNum(Type, Single)
Item.GetItemByString(User, String)
Item.GetID(Item)
Item.GetID(Type)
Item.HasID(Type)
Item.GetID<T>()
Item.GetType(Int32)
Item.GetType(String)
Item.Create<T>(Int32)
Item.Create(Type, Int32)
Item.Create<T>()
Item.Create(Type)
Item.IconName
Item.IconComment
Item.TypeID
Item.Type
Item.DisplayName
Item.Name
Item.IsUnique
Item.Fuel
Item.IsFuel
Item.WeightWithoutModifiers
Item.Weight
Item.HasWeight
Item.IsCarried
Item.IgnoreAuth
Item.Yield
Item.HasYield
Item.HasCrop
Item.CanBeCurrency
Item.MakesRoads
Item.Compostable
Item.ResourcePile
Item.CanAirInteraction
Item.Category
Item.Hidden
Item.Group
Item.MaxStackSize
Item.IsWasteProduct
Item.GetDescription
Item.HandOrigin
Item.CanBeHeld
Item.IsTool
Item.CustomHighlight
Item.AllItemsIncludingHidden
Item.AllItemsExceptHidden
Item.RandomItem
ItemRepresentation.RepresentsItemType(Item)
ItemLinkable.ShowName(Single)
ItemLinkable.ShowName(Int32)
ItemLinkable.UILinkAndNumber(Single)
ItemLinkable.UILinkAndNumber(Int32)
ItemLinkable.UILinkAndNumber(Int32, String)
ItemLinkable.UILinkAndNumberAndTier(Int32, Int32)
ItemLinkable.UILinkAndNumberAndTierPrepend(Int32, Int32, String)
ItemLinkable.UILinkAndNumberNoText(Int32)
ItemLinkable.UILinkContent()
ItemLinkable.UILinkContent(Boolean)
ItemLinkable.NameAndNum(Int32)
ItemLinkable.UILinkAndStyledNumber(Int32)
ItemLinkable.UILinkContent(LocString)
ItemLinkable.UILinkNoNumber(Int32)
ItemLinkable.UILinkContent(LinkConfig)
ItemLinkable.ItemIconUILink(LocString)
ItemLinkable.DisplayNamePlural
ItemLinkable.MarkedUpName
ItemLinkable.ControllerID
Namespace: Eco.Gameplay.Settlements.ClaimStakes
Assembly: Eco.Gameplay.dll
Syntax
[RequiresSettlement]
public abstract class SettlementClaimStakeItem : ClaimStakeItemBase, IItem, ILinkableParameterized<LinkConfig>, ILinkable, IHasIcon, IPlaceableItem, ISettlementAssociated, IController, IViewController, IHasUniversalID, INotifyPropertyChanged

Constructors

SettlementClaimStakeItem()

Declaration
protected SettlementClaimStakeItem()

Properties

IsStackable

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

Settlement

The settlement that generaed the claim stake

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

SettlementType

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

StackingHash

Declaration
public override int StackingHash { get; }
Property Value
Type Description
System.Int32
Overrides
DurabilityItem.StackingHash

WorldObjectType

Declaration
public override Type WorldObjectType { get; }
Property Value
Type Description
System.Type
Overrides
WorldObjectItem.WorldObjectType

Methods

CanClaim(Player, Vector3i)

Declaration
public override bool CanClaim(Player player, Vector3i worldPos)
Parameters
Type Name Description
Player player
Vector3i worldPos
Returns
Type Description
System.Boolean
Overrides
ClaimStakeItemBase.CanClaim(Player, Vector3i)

CanStack(Item)

Declaration
public override bool CanStack(Item other)
Parameters
Type Name Description
Item other
Returns
Type Description
System.Boolean
Overrides
DurabilityItem.CanStack(Item)

Clone()

Declaration
public override Item Clone()
Returns
Type Description
Item
Overrides
DurabilityItem.Clone()

DeedName(User)

Declaration
protected override LocString DeedName(User user)
Parameters
Type Name Description
User user
Returns
Type Description
LocString
Overrides
ClaimStakeItemBase.DeedName(User)

Destroy(Int32)

Declaration
public override void Destroy(int quantity = 1)
Parameters
Type Name Description
System.Int32 quantity
Overrides
Item.Destroy(Int32)

OnPickup(WorldObject)

Declaration
public override void OnPickup(WorldObject placedObject)
Parameters
Type Name Description
WorldObject placedObject
Overrides
WorldObjectItem.OnPickup(WorldObject)

OnPreWorldObjectPlaced(WorldObject)

Declaration
public override void OnPreWorldObjectPlaced(WorldObject placedObject)
Parameters
Type Name Description
WorldObject placedObject
Overrides
WorldObjectItem.OnPreWorldObjectPlaced(WorldObject)

OnSelected(Player)

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

RepresentativeHash()

Declaration
public override int RepresentativeHash()
Returns
Type Description
System.Int32
Overrides
DurabilityItem.RepresentativeHash()

RepresentsItem(Item)

Declaration
public override bool RepresentsItem(Item other)
Parameters
Type Name Description
Item other
Returns
Type Description
System.Boolean
Overrides
DurabilityItem.RepresentsItem(Item)

Implements

IItem
ILinkableParameterized<T>
ILinkable
IHasIcon
IPlaceableItem
ISettlementAssociated
IController
IViewController
IHasUniversalID
System.ComponentModel.INotifyPropertyChanged

Extension Methods

ItemStackExtensions.NameAndNum(ItemRepresentation, Int32)
ItemUtils.CanItemExistInInventories(Item)
ItemUtils.CloneIfNeeded(Item)
TagUtils.Tags(Item)
TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
WorldObjectUtil.RequiresComponent<T>(WorldObjectItem)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
MarketplaceExtensions.IsPaidItem(Item)
TypeTooltipExtensions.UILinkGeneric(Object)
EconomyTooltipLibrary.BuyItTooltip(Item, User, TooltipOrigin)
EconomyTooltipLibrary.SellItTooltip(Item, User, TooltipOrigin)
ILinkableTooltipLibrary.ItemLinkClicked(Item, TooltipOrigin)
SettlementTooltipLibrary.ClaimStakeItemBaseTooltip(SettlementClaimStakeItem)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾