Modding:Buildings - Revision history

imported>Abagaianye: Edited wording for DrawPosition description to make it clearer that the value is in pixels, not tiles

2026-03-25T15:11:46Z

Edited wording for DrawPosition description to make it clearer that the value is in pixels, not tiles

← Older revision		Revision as of 15:11, 25 March 2026
Line 250:		Line 250:
	\|-		\|-
	\| <samp>DrawPosition</samp>		\| <samp>DrawPosition</samp>
	\| The ~~tile~~ position at which to draw the top-left corner of the texture, relative to the building's top-left corner ~~tile~~.		\| The position at which to draw the top-left corner of the texture, relative to the building's top-left corner. Measured in pixels.
	\|-		\|-
	\| <samp>Texture</samp>		\| <samp>Texture</samp>

imported>BarleyZP: /* Format */ Add new fields from Modding:Migrate to Stardew Valley 1.6.9 (main author Pathoschild)

2025-05-19T18:43:30Z

Format: Add new fields from Modding:Migrate to Stardew Valley 1.6.9 (main author Pathoschild)

← Older revision		Revision as of 18:43, 19 May 2025
Line 93:		Line 93:
	\| <samp>Indestructible</samp>		\| <samp>Indestructible</samp>
	\| ''(Optional)'' Whether to prevent the player from destroying, picking up, or moving the item. Default false.		\| ''(Optional)'' Whether to prevent the player from destroying, picking up, or moving the item. Default false.
			\|-
			\| <samp>ClearTile</samp>
			\| ''(Optional)'' Whether to remove any item on the target tile, except for one matching the indoor item's <samp>ItemId</samp>. The previous contents of the tile will be moved into the lost and found if applicable. Default true.
	\|}		\|}
	\|-		\|-
Line 486:		Line 489:

	This can also contain arbitrary custom properties, which C# mods can read using <samp>building.GetMetadata(key)</samp>.		This can also contain arbitrary custom properties, which C# mods can read using <samp>building.GetMetadata(key)</samp>.
			\|-
			\| <samp>NameForGeneralType</samp>
			\| ''(Optional)'' A [[Modding:Tokenizable strings\|tokenizable string]] for the display name which represents the general building type, like 'Coop' for a Deluxe Coop. For example, this can be shown in Robin's started-construction dialogue. If omitted, it defaults to the <samp>Name</samp> field.
	\|-		\|-
	\| <samp>BuildingType</samp>		\| <samp>BuildingType</samp>

imported>Margotbean: direct links

2025-05-17T15:00:17Z

direct links

← Older revision		Revision as of 15:00, 17 May 2025
Line 556:		Line 556:
	\|rowspan="7"\|<samp>Cabin</samp><br /><samp>FarmHouse</samp>		\|rowspan="7"\|<samp>Cabin</samp><br /><samp>FarmHouse</samp>
	\| <samp>GetCellar</samp>		\| <samp>GetCellar</samp>
	\| Get the [[cellar]] location linked to this cabin, if any.		\| Get the [[Farmhouse#Upgrades\|cellar]] location linked to this cabin, if any.
	\|-		\|-
	\| <samp>CanAssignFarmhand</samp><br /><samp>AssignFarmhand</samp>		\| <samp>CanAssignFarmhand</samp><br /><samp>AssignFarmhand</samp>

imported>BarleyZP: /* For C# mods */ add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild)

2025-05-16T19:13:43Z

For C# mods: add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild)

← Older revision		Revision as of 19:13, 16 May 2025
Line 580:		Line 580:
	\| Get the main [[farmhouse]] building.		\| Get the main [[farmhouse]] building.
	\|-		\|-
	\| rowspan=2\|<samp>GameLocation</samp>		\| rowspan=5\|<samp>GameLocation</samp>
			\| <samp>AddDefaultBuildings</samp>
			\| Can be overridden to add custom buildings when the location is created and/or loaded. These can either be re-added whenever they're missing (like the vanilla farmhouse), or only built once on save creation (like the vanilla pre-built cabins).
			\|-
			\| <samp>GetContainingBuilding</samp>
			\| Get the building instance which contains this location (like the cabin for a cabin interior), if applicable.
			\|-
			\| <samp>GetInstancedBuildingInteriors</samp>
			\| Get all building interiors within this location which are instanced to the building (i.e. not in <samp>Game1.locations</samp> separately).
			\|-
	\| <samp>OnBuildingConstructed</samp><br /><samp>OnBuildingMoved</samp><br /><samp>OnBuildingDemolished</samp>		\| <samp>OnBuildingConstructed</samp><br /><samp>OnBuildingMoved</samp><br /><samp>OnBuildingDemolished</samp>
	\| These methods are called for all players when any player constructs, moves, or demolishes a building.		\| These methods are called for all players when any player constructs, moves, or demolishes a building.

imported>BarleyZP: /* For C# mods */ add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild)

2025-05-16T19:05:18Z

For C# mods: add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild)

@@ Line 509: / Line 509: @@
 ! effect
 |-
-|rowspan="7"| <samp>Building</samp>
+|rowspan="13"| <samp>Building</samp>
 | <samp>CreateInstanceFromId</samp>
 | Create a building instance from its type ID in <samp>Data/Buildings</samp>. For example:
@@ Line 515: / Line 515: @@
 Building shippingBin = Building.CreateInstanceFromId("Shipping Bin", Vector2.Zero); // creates an instance of StardewValley.Buildings.ShippingBin
 </syntaxhighlight>
 |-
 | <samp>GetData</samp><br /><samp>TryGetData</samp>
 | Get the data for the building's type from <samp>Data/Building</samp>.
 |-
 | <samp>GetMetadata</samp>
@@ Line 524: / Line 533: @@
 | <samp>GetPaintDataKey</samp>
 | Get the key in <samp>Data/PaintData</samp> for this building, if it has any.
 |-
 | <samp>ReloadBuildingData</samp>
 | Apply the latest data in <samp>Data/Buildings</samp> to this building.
 |-
 | <samp>UpdateTransparency</samp>
@@ Line 535: / Line 553: @@
 This method mainly exists to let mods override/patch the transparency logic.
 |-
 | <samp>Farm</samp>
@@ Line 540: / Line 580: @@
 | Get the main [[farmhouse]] building.
 |-
-| <samp>GameLocation</samp>
+| rowspan=2|<samp>GameLocation</samp>
 | <samp>OnParentBuildingUpgraded</samp>
 | Called when the building containing this location is upgraded, if applicable.

imported>BarleyZP: Added a "For C# mods" section with info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild)

2025-05-13T20:11:12Z

Added a "For C# mods" section with info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild)

@@ Line 4: / Line 4: @@
 ==Format==
-You can create/edit buildings by editing the <samp>Data/Buildings</samp> asset.
+You can create/edit buildings by editing the <samp>Data/Buildings</samp> asset. Vanilla buildings have their names and descriptions defined as [[Modding:Tokenizable strings|tokenizable strings]] in <samp>Strings/Buildings</samp>.
 This consists of a string → model lookup, where...
@@ Line 498: / Line 498: @@
 | The [[Modding:Common data field types#Custom fields|custom fields]] for this entry.
 |}
 [[Category:Modding]]
 [[ru:Модификации:Чертежи]]
 [[zh:模组:建筑]]

imported>Gravy: Added note on building entry position.

2025-01-20T02:05:02Z

Added note on building entry position.

← Older revision		Revision as of 02:05, 20 January 2025
Line 316:		Line 316:
	\| ''(Optional)'' A list of building IDs whose animals to allow in this building too. For example, <code>[ "Barn", "Coop" ]</code> will allow [[barn]] and [[coop]] animals in this building. Default none.		\| ''(Optional)'' A list of building IDs whose animals to allow in this building too. For example, <code>[ "Barn", "Coop" ]</code> will allow [[barn]] and [[coop]] animals in this building. Default none.
	\|}		\|}

			Note: the player's entry position after entering the building will be 1 tile North of the first warp in the location's warp list.

	====Item processing====		====Item processing====

imported>VulpesLucida: +zh link

2025-01-10T23:48:58Z

+zh link

← Older revision		Revision as of 23:48, 10 January 2025
Line 499:		Line 499:

	[[ru:Модификации:Чертежи]]		[[ru:Модификации:Чертежи]]
			[[zh:模组:建筑]]

imported>Pathoschild: update link

2024-12-15T19:15:09Z

update link

← Older revision		Revision as of 19:15, 15 December 2024
Line 337:		Line 337:
	\|-		\|-
	\| <samp>RequiredTags</samp>		\| <samp>RequiredTags</samp>
	\| A list of [[Modding:~~Items#~~Context tags\|context tags]] to match against an input item. An item must have ''all'' of these tags to be accepted.		\| A list of [[Modding:Context tags\|context tags]] to match against an input item. An item must have ''all'' of these tags to be accepted.
	\|-		\|-
	\| <samp>SourceChest</samp>		\| <samp>SourceChest</samp>

imported>Pathoschild: Pathoschild moved page Modding:Blueprint data to Modding:Buildings: 'blueprints' were a pre-1.6 concept

2024-11-15T23:26:25Z

Pathoschild moved page Modding:Blueprint data to Modding:Buildings: 'blueprints' were a pre-1.6 concept

← Older revision		Revision as of 23:26, 15 November 2024
(No difference)