Modding:Big craftables: Difference between revisions
imported>Pathoschild unmerge from Modding:Items; attribution: Pathoschild (main author), Margotbean (link fixes and formatting), BarleyZP (initial update for 1.6, merge info from 1.6 mod migration guide with content by Pathoschild and formatting fixes by Margotbean, merge more info from 1.6 guide with all content by Pathoschild) |
imported>Pathoschild update links |
||
| Line 9: | Line 9: | ||
This consists of a string → model lookup, where... | This consists of a string → model lookup, where... | ||
* The key is the unqualified [[Modding: | * The key is the unqualified [[Modding:Common data field types#Item ID|item ID]]. | ||
* The value is a model with the fields listed below. | * The value is a model with the fields listed below. | ||
| Line 77: | Line 77: | ||
|- | |- | ||
| <samp>CustomFields</samp> | | <samp>CustomFields</samp> | ||
| ''(Optional)'' The [[Modding: | | ''(Optional)'' The [[Modding:Common data field types#Custom fields|custom fields]] for this entry. | ||
|} | |} | ||
===Notes=== | ===Notes=== | ||
* Many of the items in the data asset aren't implemented in-game. They may be completely absent from the game, or they may be unused as craftables and instead appear in [[ | * Many of the items in the data asset aren't implemented in-game. They may be completely absent from the game, or they may be unused as craftables and instead appear in [[Modding:Objects|object data]] or [[Modding:Furniture|furniture data]]. | ||
[[Category:Modding]] | [[Category:Modding]] | ||
Revision as of 18:29, 15 December 2024
← Items
Big craftables
Big craftables are objects which can be placed in the world and are two tiles tall (instead of one like objects).
They have their data in Data/BigCraftables (Data/BigCraftablesInformation prior to 1.6), their in-game sprites in TileSheets/Craftables, and their code in StardewValley.Object (with the bigCraftable.Value = true flag).
Data format
This consists of a string → model lookup, where...
- The key is the unqualified item ID.
- The value is a model with the fields listed below.
Basic info
| field | purpose |
|---|---|
| Name | The internal item name. |
| DisplayName Description |
A tokenizable string for the item's in-game display name and description. |
| Price | (Optional) The price when sold by the player. This is not the price when bought from a shop. Default 0. |
Behavior
| field | purpose |
|---|---|
| Fragility | (Optional) How the item can be picked up. The possible values are 0 (pick up with any tool), 1 (destroyed if hit with an axe/hoe/pickaxe, or picked up with any other tool), or 2 (can't be removed once placed). Default 0. |
| CanBePlacedIndoors CanBePlacedOutdoors |
(Optional) Whether the item can be placed indoors or outdoors. Default true. |
| IsLamp | (Optional) Whether this is a lamp and should produce light when dark. Default false. |
Appearance
| field | purpose |
|---|---|
| Texture | (Optional) The asset name for the texture containing the item's sprite. Defaults to TileSheets/Craftables. |
| SpriteIndex | (Optional) The sprite's index within the Texture, where 0 is the top-left sprite. |
Context tags
| field | purpose |
|---|---|
| ContextTags | (Optional) The custom context tags to add for this item (in addition to the tags added automatically based on the other object data). This is formatted as a list; for example:
"ContextTags": [ "light_source", "torch_item" ]
|
Advanced
| field | purpose |
|---|---|
| CustomFields | (Optional) The custom fields for this entry. |
Notes
- Many of the items in the data asset aren't implemented in-game. They may be completely absent from the game, or they may be unused as craftables and instead appear in object data or furniture data.