Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IItemDescription

Hierarchy

Index

Properties

Optional actionTier

actionTier: OptionalDescriptions<ActionType, number>

The level at which the items performs a certain action. The higher the number, the better. This impacts things like stamina usage, success rate, resource amount, etc.

Optional attack

attack: undefined | number

Optional blockDisassembly

blockDisassembly: undefined | false | true

Can be set to true if you don't want the player to actually disassemble the item, but still have disassembly data via the disassemble property.

Optional burnsLike

burnsLike: ItemType[]

Optional canCureStatus

canCureStatus: StatusType[]

Array of status effects that using this item (via ConsumeItem) will cure.

Optional containedItemsInsulation

containedItemsInsulation: IInsulationDescription

A decimal number from 0 to 1.

  • An insulation of 0 means that the temperature inside this object is equivalent to the temperature outside.
  • An insulation of 1 means that no temperature inside this object is emitted to the outside tiles — it is a completely separate temperature "biome".
  • Values in between change how much of the temperatures are produced/used on either side.

Optional craftable

craftable: undefined | false | true

Optional createOnBreak

createOnBreak: ICreateOnBreak

Creates creatures or tile events when it breaks.

Optional createTileEventOnCraft

createTileEventOnCraft: TileEventType

Creates this tile event when using this item in a craft. The tileEventByProduct boolean must be set to true on the recipe calling this item.

Optional damageModifier

damageModifier: undefined | number

Optional damageOnUse

damageOnUse: Record<number, any>

Optional damageType

damageType: DamageType

Optional decayMax

decayMax: undefined | number

Optional decayTemperatureRange

decayTemperatureRange: IDecayTemperatureRange

Optional decaysInto

decaysInto: ItemType[]

Optional defense

defense: Defense

Optional disassemble

disassemble: undefined | false | true

Optional dismantle

Optional doodadContainer

doodadContainer: DoodadType

Optional durability

durability: undefined | number

Optional durabilityDistribution

durabilityDistribution: undefined | number

An amount of durability that the item can start with lost. Defaults to 3

Optional durabilityModifierAtStart

durabilityModifierAtStart: undefined | number

A decimal number between 0 and 1 representing how much of the item's durability can already be gone when the item is created

Optional equip

equip: EquipType

Optional equipEffect

equipEffect: EquipEffects

Optional equippedInsulation

equippedInsulation: IInsulationDescription

A decimal number from 0 to 1.

  • An insulation of 0 means that the temperature inside this object is equivalent to the temperature outside.
  • An insulation of 1 means that no temperature inside this object is emitted to the outside tiles — it is a completely separate temperature "biome".
  • Values in between change how much of the temperatures are produced/used on either side.

Optional firedWith

firedWith: ItemTypeGroup

Specifies with item group (weapon) this ammunition can be fired with.

Optional flammable

flammable: undefined | false | true

If set to true, the item will count as something you can start on fire or where fire can spread to. By default, after it burns, it will burn into its disassembly items unless the onBurn property is set.

Optional gather

gather: ILiquid

Optional hasSleepImage

hasSleepImage: undefined | false | true

Optional hideHelmet

hideHelmet: undefined | false | true

Optional imagePath

imagePath: undefined | string

A replacement image to use. Used in modding.

Optional inheritWeight

inheritWeight: ItemType

Optional isVehicle

isVehicle: undefined | false | true

Optional keepDurabilityOnCraft

keepDurabilityOnCraft: undefined | false | true

Optional lit

Optional meltsInto

meltsInto: TileEventType[]

Array of tile events that are spawned when the item melts.

Optional messages

messages: undefined | { destroyed?: Message; nearDestroyed?: Message }

Custom messages for specific items

Optional minimumWeight

minimumWeight: undefined | number

Optional modIndex

modIndex: undefined | number

Optional onBurn

onBurn: ItemType[]

Do not use this property is you do not want the item to burn at all. Set it to [ItemType.None] if you want it to burn but not produce anything. Otherwise, set it to an array of items you want it to burn into. This also interacts with the flammable property, so look at that as well.

Optional onUse

onUse: IOnUse

Optional placeDownType

placeDownType: DoodadType

Optional plural

plural: undefined | string

Optional prefix

prefix: undefined | string

Optional preservationChance

preservationChance: undefined | number

Optional ranged

ranged: IRanged

Optional recipe

recipe: IRecipe

Optional recipeCache

recipeCache: ItemType[]

Optional recipes

recipes: Array<(recipe: Recipe) => Recipe>

A list of recipes that have this item as an output.

This helper is intended for simple recipes that don't need to change how many of the item are created, and from what. If you intend to output a number of this item greater than one, or you intend to produce this item by changing another item into it, consider instead registering a recipe directly.

Optional reducedWeight

reducedWeight: undefined | number

Optional refiningReduction

refiningReduction: undefined | number

A decimal number between 0 and 1 that will reduce the weightFraction of a "raw" item when it's refined.

Optional reinforcable

reinforcable: undefined | false | true

Set to false if you do not want the item to be reinforcable. Items with a durability property will be reinforcable by default.

Optional repairAndDisassemblyRequiresFire

repairAndDisassemblyRequiresFire: undefined | false | true

Optional repairable

repairable: undefined | false | true

Optional requiredForDisassembly

requiredForDisassembly: Array<ItemType | ItemTypeGroup>

Optional returnOnUseAndDecay

returnOnUseAndDecay: IItemReturn

Optional revert

revert: ItemType

Optional showOverHair

showOverHair: undefined | false | true

Optional skillUse

skillUse: SkillType

Optional spawnOnDecay

spawnOnDecay: CreatureType

Optional spawnOnMerchant

spawnOnMerchant: BiomeType[]

Array of biome types that the item can spawn in merchant's inventory for trade. Leave empty or unset if item spawns on merchants in any biome type.

Optional spawnOnWorldGen

Optional spawnableTiles

spawnableTiles: TileGroup

Optional suffix

suffix: undefined | string

Optional temperature

temperature: undefined | number

The produced temperature of this object — objects whose temperature affects surrounding objects. A number between Temperature.Coldest and Temperature.Hottest. When not provided, Temperature.Neutral is used.

Optional tier

How good this item is at being an item of an ItemTypeGroup.

For instance, ItemType.StoneSpear has a ItemTypeGroup.CookingEquipment tier of 2.

Optional twoHanded

twoHanded: undefined | false | true

Optional use

use: ActionType[]

Optional weight

weight: undefined | number

Optional weightCapacity

weightCapacity: undefined | number

Optional weightRange

weightRange: []

Optional worth

worth: undefined | number

Methods

Optional onEquip

  • onEquip(item: Item): void
  • Parameters

    Returns void

Optional onUnequip

  • onUnequip(item: Item): void
  • Parameters

    Returns void

Generated using TypeDoc