Show / Hide Table of Contents

Class ClaimPaperItemBase

This is the base class for all claim papers.

Inheritance
System.Object
ItemLinkable
ItemRepresentation
Item
ClaimPaperItemBase
ClaimPaperItem
HomesteadSupportClaimPaperItem
Implements
IItem
ILinkableParameterized<LinkConfig>
ILinkable
IHasIcon
ISettlementAssociated
IController
IViewController
IHasUniversalID
System.ComponentModel.INotifyPropertyChanged
IThreadSafeSubscriptions
ISubscriptions<ThreadSafeSubscriptions>
ISubscriptions
Inherited Members
Item.ItemsInitialized
Item.RepresentsItemType(Type)
Item.CanStack(Item)
Item.Merge(Item, Int32, Int32, Boolean)
Item.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)
Item.ClearMaxStackSizeCache()
Item.GetMaxStackSize(Type)
Item.GetMaxStackSizeRaw(Type)
Item.ToString()
Item.UnsubscribeUnique()
Item.OnUsed(Player, ItemStack)
Item.OnLeftClicked(Player, ItemStack)
Item.OnSelected(Player)
Item.OnDeselected(Player)
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.Initialize()
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.Items
Assembly: Eco.Gameplay.dll
Syntax
public abstract class ClaimPaperItemBase : Item, IItem, ILinkableParameterized<LinkConfig>, ILinkable, IHasIcon, ISettlementAssociated, IController, IViewController, IHasUniversalID, INotifyPropertyChanged, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions

Constructors

ClaimPaperItemBase()

Declaration
protected ClaimPaperItemBase()

Properties

IsStackable

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

Settlement

Claiming is limited to this settlement, if set.

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

StackingHash

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

Subscriptions

Declaration
public ref ThreadSafeSubscriptions Subscriptions { get; }
Property Value
Type Description
ThreadSafeSubscriptions

Methods

CanBeAddedToStake(WorldObject, Deed)

Check whether these papers can be added to the specified claim stake or not.

Declaration
public abstract Result CanBeAddedToStake(WorldObject claimStake, Deed parentDeed)
Parameters
Type Name Description
WorldObject claimStake
Deed parentDeed
Returns
Type Description
Result

CanBeCountedForStakePlots(WorldObject, Deed)

We check whether these papers can be counted toward the maximum of allowed plots of the specified claim stake or not.

Declaration
public abstract Result CanBeCountedForStakePlots(WorldObject claimStake, Deed parentDeed)
Parameters
Type Name Description
WorldObject claimStake
Deed parentDeed
Returns
Type Description
Result

Clone()

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

Deduct(Int32)

Declaration
protected abstract void Deduct(int quantity)
Parameters
Type Name Description
System.Int32 quantity

Destroy(Int32)

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

RepresentativeHash()

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

RepresentsItem(Item)

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

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

IItem
ILinkableParameterized<T>
ILinkable
IHasIcon
ISettlementAssociated
IController
IViewController
IHasUniversalID
System.ComponentModel.INotifyPropertyChanged
IThreadSafeSubscriptions
ISubscriptions<TSubscriptionsList>
ISubscriptions

Extension Methods

ItemStackExtensions.NameAndNum(ItemRepresentation, Int32)
ItemUtils.CanItemExistInInventories(Item)
TagUtils.Tags(Item)
TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
MarketplaceExtensions.IsPaidItem(Item)
TypeTooltipExtensions.UILinkGeneric(Object)
ILinkableTooltipLibrary.ItemLinkClicked(Item, TooltipOrigin)
ItemTooltipLibrary.PropertyClaimTooltip(ClaimPaperItemBase)
ItemTooltipLibrary.PropertyClaimTooltipTitle(ClaimPaperItemBase)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾