Show / Hide Table of Contents

Class ClaimToolBaseItem

The ClaimToolBaseItem serves as a representation of the 'Claim Tool' object. It contains the actions performed to expand, or remove plots from selected deed/property.

Inheritance
System.Object
ItemLinkable
ItemRepresentation
Item
DurabilityItem
RepairableItem
ToolItem
ClaimToolBaseItem
Implements
IItem
ILinkableParameterized<LinkConfig>
ILinkable
IHasIcon
System.ComponentModel.INotifyPropertyChanged
IPlaceableItem
IThreadSafeSubscriptions
ISubscriptions<ThreadSafeSubscriptions>
ISubscriptions
IInteractor
IHasInteractions
IController
IViewController
IHasUniversalID
Inherited Members
ToolItem.CreateCalorieValue(Single, Type, Type)
ToolItem.CreateDamageValue(Single, Type, Type)
ToolItem.CreateSkillModifiedValue(Single, ModificationStrategy, Type, Type, LocString, DynamicValueType)
ToolItem.IsValidForInteraction(Item)
ToolItem.UseDurability(Single, Player, Boolean)
ToolItem.NeededCalories(Player, Single)
ToolItem.BurnCaloriesNow(Player, Single)
ToolItem.AddExperience(User, Single, GameActionDescription)
ToolItem.AddExperience(User, Single, LocString)
ToolItem.CanStack(Item)
ToolItem.CanPickUpItemStack(ItemStack)
ToolItem.GetNoSuitablePickupTargetFailureMessage(Inventory)
ToolItem.GetItemsUserCanTake(WorldObject, Item, Boolean)
ToolItem.UseToolRPC(Player)
ToolItem.GetPreferredInventoryToPullFrom(WorldObject)
ToolItem.ExperienceSkill
ToolItem.ExperienceRate
ToolItem.CaloriesBurn
ToolItem.DurabilityBurn
ToolItem.PerkDamage
ToolItem.Tier
ToolItem.Damage
ToolItem.SkilledRepairCost
ToolItem.CanBeHeld
ToolItem.MaxTake
ToolItem.CanBeUsedWithEmotes
ToolItem.DescribeBlockAction
ToolItem.IsStackable
ToolItem.BrokenDescription
RepairableItem.RepresentativeHash()
RepairableItem.MaterialRepairsItem(Type)
RepairableItem.DescribeRepairCost(User, Boolean)
RepairableItem.RepairCost(User, Single)
RepairableItem.GetQualityGroup()
RepairableItem.Clone()
RepairableItem.GetDurability()
RepairableItem.SetDurability(Single)
RepairableItem.DurabilityPercent
RepairableItem.Durability
RepairableItem.DefaultMinRequiredIntegrityInTradeOffers
RepairableItem.IntegrityAmount
RepairableItem.IntegrityPercent
RepairableItem.RepairPenaltyToDurability
RepairableItem.RepairItem
RepairableItem.RepairItems
RepairableItem.RepairTag
RepairableItem.CanBeRepaired
RepairableItem.FullRepairAmount
RepairableItem.SkillReqs
RepairableItem.PercentBrokenFromOriginal
DurabilityItem.RepresentsItem(Item)
DurabilityItem.Merge(Item, Int32, Int32, Boolean)
DurabilityItem.OriginalMaxDurability
DurabilityItem.DisplayDurability
DurabilityItem.Broken
DurabilityItem.StackingHash
DurabilityItem.DefaultMinRequiredDurabilityInTradeOffers
DurabilityItem.PropertyChanged
Item.ItemsInitialized
Item.RepresentsItemType(Type)
Item.OnLinkClicked(TooltipOrigin, TooltipClickContext, User)
Item.ClearMaxStackSizeCache()
Item.GetMaxStackSize(Type)
Item.Destroy(Int32)
Item.ToString()
Item.UnsubscribeUnique()
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.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.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
Assembly: Eco.Gameplay.dll
Syntax
public abstract class ClaimToolBaseItem : ToolItem, IItem, ILinkableParameterized<LinkConfig>, ILinkable, IHasIcon, INotifyPropertyChanged, IPlaceableItem, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IInteractor, IHasInteractions, IController, IViewController, IHasUniversalID

Constructors

ClaimToolBaseItem()

Declaration
protected ClaimToolBaseItem()

Fields

UnlimitedClaiming

If this is set, allow it to claim without papers.

Declaration
public bool UnlimitedClaiming
Field Value
Type Description
System.Boolean

Properties

Decays

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

Deed

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

HandOrigin

Declaration
public override ItemHandOrigin HandOrigin { get; }
Property Value
Type Description
ItemHandOrigin
Overrides
Item.HandOrigin

Subscriptions

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

Methods

Claim(Player, InteractionTriggerInfo, InteractionTarget)

Declaration
[Interaction]
public bool Claim(Player player, InteractionTriggerInfo triggerInfo, InteractionTarget target)
Parameters
Type Name Description
Player player
InteractionTriggerInfo triggerInfo
InteractionTarget target
Returns
Type Description
System.Boolean

OnDeselected(Player)

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

OnSelected(Player)

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

OnUsed(Player, ItemStack)

Allow changing assigned deed when right-clicked.

Declaration
public override string OnUsed(Player player, ItemStack itemStack)
Parameters
Type Name Description
Player player
ItemStack itemStack
Returns
Type Description
System.String
Overrides
Item.OnUsed(Player, ItemStack)

Unclaim(Player, InteractionTriggerInfo, InteractionTarget)

Declaration
[Interaction]
public bool Unclaim(Player player, InteractionTriggerInfo triggerInfo, InteractionTarget target)
Parameters
Type Name Description
Player player
InteractionTriggerInfo triggerInfo
InteractionTarget target
Returns
Type Description
System.Boolean

Implements

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

Extension Methods

MultiblockContextHelpers.CreateMultiblockContext(ToolItem, Player, Boolean, Vector3i, IEnumerable<Type>, Func<GameAction>)
MultiblockContextHelpers.CreateMultiblockContext(ToolItem, Player, Boolean, IEnumerable<Vector3i>, IEnumerable<Type>, Func<GameAction>)
MultiblockContextHelpers.TryCreateMultiblockContext(ToolItem, out MultiblockActionContext, InteractionTarget, Player, Boolean, IEnumerable<Type>, Func<GameAction>, IEnumerable<String>, IEnumerable<String>, String[])
MultiblockContextHelpers.TryCreateMultiblockContext(ToolItem, out MultiblockActionContext, InteractionTarget, Player, IEnumerable<Tag>, Boolean, IEnumerable<Type>, Func<GameAction>, IEnumerable<Tag>, IEnumerable<Tag>)
ItemStackExtensions.NameAndNum(ItemRepresentation, Int32)
ItemUtils.CanItemExistInInventories(Item)
ItemUtils.CloneIfNeeded(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)
DeedTooltipLibrary.ClaimToolTooltip(ClaimToolBaseItem)
DurabilityItemTooltipLibrary.TooltipDurability(RepairableItem, User)
EconomyTooltipLibrary.BuyItTooltip(Item, User, TooltipOrigin)
EconomyTooltipLibrary.SellItTooltip(Item, User, TooltipOrigin)
ILinkableTooltipLibrary.ItemLinkClicked(Item, TooltipOrigin)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾