Class ToolItem

[ItemGroup("Tools")]
[MaxStackSize(1)]
public abstract class ToolItem : RepairableItem, IItem, ILinkableParameterized<LinkConfig>, ILinkable, IHasIcon, INotifyPropertyChanged, IInteractor, IHasInteractions, IPlaceableItem, IController, IViewController, IHasUniversalID

Constructors

ToolItem()

Declaration

protected ToolItem()

Properties

AnimalDamage

Declaration

public virtual float AnimalDamage { get; }

Property Value

Type	Description
System.Single

BrokenDescription

Declaration

public override LocString BrokenDescription { get; }

Property Value

Type	Description
LocString

Overrides

DurabilityItem.BrokenDescription

CaloriesBurn

Declaration

public virtual IDynamicValue CaloriesBurn { get; }

Property Value

Type	Description
IDynamicValue

CanBeHeld

Declaration

public override bool CanBeHeld { get; }

Property Value

Type	Description
System.Boolean

Overrides

Item.CanBeHeld

CanBeUsedWithEmotes

Declaration

public virtual bool CanBeUsedWithEmotes { get; }

Property Value

Type	Description
System.Boolean

Damage

Declaration

public virtual IDynamicValue Damage { get; }

Property Value

Type	Description
IDynamicValue

DescribeBlockAction

Declaration

public virtual GameActionDescription DescribeBlockAction { get; }

Property Value

Type	Description
GameActionDescription

DurabilityBurn

Declaration

public virtual IDynamicValue DurabilityBurn { get; }

Property Value

Type	Description
IDynamicValue

ExperienceRate

Declaration

public virtual IDynamicValue ExperienceRate { get; }

Property Value

Type	Description
IDynamicValue

ExperienceSkill

Declaration

public virtual Type ExperienceSkill { get; }

Property Value

Type	Description
System.Type

IsStackable

Declaration

public override bool IsStackable { get; }

Property Value

Type	Description
System.Boolean

Overrides

DurabilityItem.IsStackable

MaxTake

Declaration

public virtual int MaxTake { get; }

Property Value

Type	Description
System.Int32

PerkDamage

Declaration

public virtual IDynamicValue PerkDamage { get; }

Property Value

Type	Description
IDynamicValue

SkilledRepairCost

Declaration

public override IDynamicValue SkilledRepairCost { get; }

Property Value

Type	Description
IDynamicValue

Overrides

RepairableItem.SkilledRepairCost

Tier

Declaration

public virtual IDynamicValue Tier { get; }

Property Value

Type	Description
IDynamicValue

Methods

AddExperience(User, Single, GameActionDescription)

Declaration

public void AddExperience(User user, float multiplier, GameActionDescription desc)

Parameters

Type	Name	Description
User	user
System.Single	multiplier
GameActionDescription	desc

AddExperience(User, Single, LocString)

Declaration

public void AddExperience(User user, float multiplier, LocString desc)

Parameters

Type	Name	Description
User	user
System.Single	multiplier
LocString	desc

BurnCaloriesNow(Player, Single)

Declaration

protected void BurnCaloriesNow(Player player, float calorieMultiplier = 1F)

Parameters

Type	Name	Description
Player	player
System.Single	calorieMultiplier

CanPickUpItemStack(ItemStack)

Declaration

public virtual bool CanPickUpItemStack(ItemStack stack)

Parameters

Type	Name	Description
ItemStack	stack

Returns

Type	Description
System.Boolean

CanStack(Item)

Declaration

public override bool CanStack(Item other)

Parameters

Type	Name	Description
Item	other

Returns

Type	Description
System.Boolean

Overrides

RepairableItem.CanStack(Item)

CreateCalorieValue(Single, Type, Type)

Declaration

protected static SkillModifiedValue CreateCalorieValue(float startValue, Type skillType, Type beneficiary)

Parameters

Type	Name	Description
System.Single	startValue
System.Type	skillType
System.Type	beneficiary

Returns

Type	Description
SkillModifiedValue

CreateDamageValue(Single, Type, Type)

Declaration

protected static SkillModifiedValue CreateDamageValue(float startValue, Type skillType, Type beneficiary)

Parameters

Type	Name	Description
System.Single	startValue
System.Type	skillType
System.Type	beneficiary

Returns

Type	Description
SkillModifiedValue

CreateSkillModifiedValue(Single, ModificationStrategy, Type, Type, LocString, DynamicValueType)

Declaration

protected static SkillModifiedValue CreateSkillModifiedValue(float startValue, ModificationStrategy strategy, Type skillType, Type beneficiary, LocString benefitText, DynamicValueType valueType)

Parameters

Type	Name	Description
System.Single	startValue
ModificationStrategy	strategy
System.Type	skillType
System.Type	beneficiary
LocString	benefitText
DynamicValueType	valueType

Returns

Type	Description
SkillModifiedValue

GetItemsUserCanTake(WorldObject, Item, Boolean)

Declaration

public List<Item> GetItemsUserCanTake(WorldObject worldObject, Item carriedItem, bool takeAll = false)

Parameters

Type	Name	Description
WorldObject	worldObject
Item	carriedItem
System.Boolean	takeAll

Returns

Type	Description
System.Collections.Generic.List<Item>

GetNoSuitablePickupTargetFailureMessage(Inventory)

Declaration

public virtual LocString GetNoSuitablePickupTargetFailureMessage(Inventory inventory)

Parameters

Type	Name	Description
Inventory	inventory

Returns

Type	Description
LocString

GetPreferredInventoryToPullFrom(WorldObject)

Declaration

protected Inventory GetPreferredInventoryToPullFrom(WorldObject worldObject)

Parameters

Type	Name	Description
WorldObject	worldObject

Returns

Type	Description
Inventory

IsValidForInteraction(Item)

Declaration

public virtual bool IsValidForInteraction(Item item)

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
System.Boolean

NeededCalories(Player, Single)

Declaration

public float NeededCalories(Player player, float calorieMultiplier = 1F)

Parameters

Type	Name	Description
Player	player
System.Single	calorieMultiplier

Returns

Type	Description
System.Single

UseDurability(Single, Player, Boolean)

Declaration

public override void UseDurability(float amountToConsume, Player player, bool notify = true)

Parameters

Type	Name	Description
System.Single	amountToConsume
Player	player
System.Boolean	notify

Overrides

RepairableItem.UseDurability(Single, Player, Boolean)

UseTool(GameActionPack, MultiblockActionContext)

Declaration

public virtual void UseTool(GameActionPack pack, MultiblockActionContext context)

Parameters

Type	Name	Description
GameActionPack	pack
MultiblockActionContext	context

UseToolRPC(Player)

Declaration

public void UseToolRPC(Player p)

Parameters

Type	Name	Description
Player	p

Implements

IItem

ILinkableParameterized<T>

ILinkable

IHasIcon

System.ComponentModel.INotifyPropertyChanged

IInteractor

IHasInteractions

IPlaceableItem

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)

TagUtils.Tags(Item)

TagUtils.TagNames(Object, Boolean)

TagUtils.TagDisplayNames(Object, Boolean)

ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)

MarketplaceExtensions.IsPaidItem(Item)

TypeTooltipExtensions.UILinkGeneric(Object)

DurabilityItemTooltipLibrary.TooltipDurability(DurabilityItem, User)

ILinkableTooltipLibrary.ItemLinkClicked(Item, TooltipOrigin)