Shop - Revision history

Thebigh: /* Readables for Sale */ -typo

2026-02-14T11:29:43Z

Readables for Sale: -typo

← Older revision		Revision as of 11:29, 14 February 2026
Line 117:		Line 117:
	shopitem_1_2_qty 1		shopitem_1_2_qty 1

	Change the shopitem_1 to some other number if you've already got other things to buy in the store. You can repeat this process for multiple purchasable readables. Just call them atdm:cryptic_clue and ShopItem_cryptic_clue, or ~~whatver~~ you like, to distinguish them from the first one you made.		Change the shopitem_1 to some other number if you've already got other things to buy in the store. You can repeat this process for multiple purchasable readables. Just call them atdm:cryptic_clue and ShopItem_cryptic_clue, or whatever you like, to distinguish them from the first one you made.

	== On Numbering ==		== On Numbering ==

Thebigh: add section for purchasable readables

2025-02-14T08:57:35Z

add section for purchasable readables

← Older revision		Revision as of 08:57, 14 February 2025
Line 75:		Line 75:

	Create a map_shop_icon graphic file in the correct directory, or optionally comment this line out to omit the in-store icon entirely.		Create a map_shop_icon graphic file in the correct directory, or optionally comment this line out to omit the in-store icon entirely.

			=== Readables for Sale ===

			Creating a readable for sale in the shop is only a little more complicated than creating a map.

			First, let's set up the readable's text. For this example, our readable will be a rolled-up scroll with the "ellianerelle" font. Go into DarkRadiant and create an atdm:readable_mobile_scroll01_rolledup, and set the font and document text in the readable editor. When you're done, delete the scroll you just created. The scroll's text is still preserved in your map's xdata folder, which is all we need for now.

			Now go into your defs folder and create two entries as follows:

			entityDef atdm:hot_tip
			{
			"inherit" "atdm:readable_mobile_scroll01_rolledup"
			"editor_usage" "hot tip" // THIS ONLY SHOWS IN ENTITY INSPECTOR
			"inv_name" "Hot Tip" // SHOWS IN PLAYER'S INVENTORY.
			"inv_icon" "guis/assets/hud/inventory_icons/scroll_tied_up_icon.tga"
			"gui" "guis/scroll_ellianerelle.gui"
			"xdata_contents" "readables/mylevel/hot_tip"
			}

			entityDef ShopItem_hot_tip
			{
			"inherit" "atdm:shopitem_base"
			"itemClassname" "atdm:hot_tip"
			"displayName" "Hot Tip"
			"displayDesc" "An acquaintance has some useful information... for a price."
			"image" "guis/assets/hud/inventory_icons/scroll_tied_up_icon.tga"
			}

			Check your xdata file to make sure the atdm:hot_tip refers to the correct xdata.

			Finally, go to your shop entity in DarkRadiant and give it the following spawnargs:

			shopitem_1_0_item atdm:hot_tip
			shopitem_1_1_item atdm:hot_tip
			shopitem_1_2_item atdm:hot_tip
			shopitem_1_0_price 50
			shopitem_1_1_price 50
			shopitem_1_2_price 50
			shopitem_1_0_qty 1
			shopitem_1_1_qty 1
			shopitem_1_2_qty 1

			Change the shopitem_1 to some other number if you've already got other things to buy in the store. You can repeat this process for multiple purchasable readables. Just call them atdm:cryptic_clue and ShopItem_cryptic_clue, or whatver you like, to distinguish them from the first one you made.

	== On Numbering ==		== On Numbering ==

Thebigh: /* Items for Sale */ -add section for adding a map

2022-02-18T22:00:10Z

Items for Sale: -add section for adding a map

@@ Line 58: / Line 58: @@
   "shopItem_N_D_persistent"   "1"
 Use that for items that are acquirable only in the shop, not while playing the mission. Otherwise I'd recommend setting the "inv_persistent" spawnarg on the inventory items in the map itself.
 == On Numbering ==

Greebo: Purchase Items moved to Shop

2011-05-01T15:42:55Z

Purchase Items moved to Shop

← Older revision	Revision as of 15:42, 1 May 2011
(No difference)

Greebo: /* Shop Budget = */

2011-05-01T15:39:49Z

Shop Budget =

← Older revision		Revision as of 15:39, 1 May 2011
Line 69:		Line 69:
	Note the missing "2" in the indexing. The parser just continues, which should make prefabbing easier and set up more robust against user errors.		Note the missing "2" in the indexing. The parser just continues, which should make prefabbing easier and set up more robust against user errors.

	== Shop Budget ===		== Shop Budget ==
	Use the spawnarg		Use the spawnarg
	"shop_gold_start" "700"		"shop_gold_start" "700"
	to define how much gold the player can spend in the shop. Authors of multi-mission projects might want to look further down this page on controlling the player's budget with regard to their collected loot.		to define how much gold the player can spend in the shop. Authors of multi-mission projects might want to look further down this page on controlling the player's budget with regard to their collected loot.

			The above spawnarg applies to all difficulty levels, unless it's overridden by one or more of the spawnargs below:
			"diff_0_shop_gold_start" "600"
			"diff_1_shop_gold_start" "400"
			"diff_2_shop_gold_start" "200"
			The number 0 in diff_0_shop_gold_start will refer to the easiest difficulty setting, e.g. "Easy".

	== Limiting the Loot from previous Missions ==		== Limiting the Loot from previous Missions ==

Greebo at 15:37, 1 May 2011

2011-05-01T15:37:16Z

← Older revision		Revision as of 15:37, 1 May 2011
Line 1:		Line 1:
	~~{{todo}} <!-- needs cleanign up talking about code changes and turn this into a proper step-by-step tutorial from the mappers point of view -->~~
	~~''originally posted by joebarnin''~~

	Click here for a [[default purchasable items]] template.		Click here for a [[default purchasable items]] template.

Greebo at 15:37, 1 May 2011

2011-05-01T15:37:00Z

@@ Line 12: / Line 12: @@
 Once added to the map, you can define the shop items and starting equipment by adding spawnargs to this entity.
 == Starting Equipment ==
@@ Line 25: / Line 29: @@
 It's possible to prevent the player from dropping a starting equipment item in the Shop by adding a spawnarg like this:
   "startingItem_N_D_candrop"  "0"
-By default all items are droppable, so set that argument to "0" to prevent that.
+By default all items are droppable, so set that argument to "0" to prevent that, for use with mission-critical items (like lockpicks) so full start equipment can be shown in the shop without risk the player will drop something crucial.
 === Examples ===
@@ Line 68: / Line 72: @@
 Note the missing "2" in the indexing. The parser just continues, which should make prefabbing easier and set up more robust against user errors.
-=== Notes ===
+== Shop Budget ===
-* It's possible to add multiple shop entities to your map, it might be convenient to have a separate shop entity for each difficulty level, in the end it's a matter of taste.
+Use the spawnarg
-* It's also possible to define these spawnargs on the worldspawn entity - this was the original method (way back in about 2007/2008). It's still supported but I'd rather not do it that way.
+  "shop_gold_start"    "700"
+to define how much gold the player can spend in the shop. Authors of multi-mission projects might want to look further down this page on controlling the player's budget with regard to their collected loot.
-== Limit the Loot from previous Missions ==
+== Limiting the Loot from previous Missions ==
 This section is applicable to campaigns or multi-mission setups: the mapper can define how much loot collected in Mission 1 will be usable in the shop before Mission 2. It's possible to define "conversion rates" for the various loot types (e.g. "10 goods are worth 1 gold"), absolute and relative gold losses as well as minimum and maximum values.

Greebo: /* Numbering */

2011-05-01T15:33:50Z

Numbering

← Older revision		Revision as of 15:33, 1 May 2011
Line 58:		Line 58:
	Use that for items that are acquirable only in the shop, not while playing the mission. Otherwise I'd recommend setting the "inv_persistent" spawnarg on the inventory items in the map itself.		Use that for items that are acquirable only in the shop, not while playing the mission. Otherwise I'd recommend setting the "inv_persistent" spawnarg on the inventory items in the map itself.

	=== Numbering ===		== On Numbering ==
	Unlike many other setup entities, you don't have to use a sequential numbering on atdm:shop. The code is able to handle gaps in the sequences, so you don't have to renumber everything each time you remove a shop item. For instance, it's now possible to do something like this:		Unlike many other setup entities, you don't have to use a sequential numbering on atdm:shop. The code is able to handle gaps in the sequences, so you don't have to renumber everything each time you remove a shop item. For instance, it's now possible to do something like this:

Greebo: /* Optional Spawnargs */

2011-05-01T15:33:26Z

Optional Spawnargs

← Older revision		Revision as of 15:33, 1 May 2011
Line 53:		Line 53:
	"shopItem_N_D_price" "PRICE"		"shopItem_N_D_price" "PRICE"
	Placing such a spawnarg will override the price of the item found on the ShopItem_YYY entityDef.		Placing such a spawnarg will override the price of the item found on the ShopItem_YYY entityDef.

			There's another spawnarg affecting the item's persistency:
			"shopItem_N_D_persistent" "1"
			Use that for items that are acquirable only in the shop, not while playing the mission. Otherwise I'd recommend setting the "inv_persistent" spawnarg on the inventory items in the map itself.

	=== Numbering ===		=== Numbering ===

Greebo: /* Items for Sale */

2011-05-01T15:31:27Z

Items for Sale

← Older revision		Revision as of 15:31, 1 May 2011
Line 48:		Line 48:

	N refers is just an index to enumerate the various shop items. The number D is defining the difficulty level this shop item applies to (which can be 0, 1 or 2, with 0 being the lowest level "Easy"). The value ITEMCLASSNAME is usually a classname, which is referring to the shop item definition in tdm_shopitems.def, e.g. the value '''atdm:weapon_broadhead''' would be pointing to the shop item entityDef '''ShopItem_weapon_broadhead'''. The second key/value pair defines the amount of items that are for sale, e.g. "10".		N refers is just an index to enumerate the various shop items. The number D is defining the difficulty level this shop item applies to (which can be 0, 1 or 2, with 0 being the lowest level "Easy"). The value ITEMCLASSNAME is usually a classname, which is referring to the shop item definition in tdm_shopitems.def, e.g. the value '''atdm:weapon_broadhead''' would be pointing to the shop item entityDef '''ShopItem_weapon_broadhead'''. The second key/value pair defines the amount of items that are for sale, e.g. "10".

			=== Optional Spawnargs ===
			It's possible to override the cost of an item for sale, add this key/value pair to your shop entity:
			"shopItem_N_D_price" "PRICE"
			Placing such a spawnarg will override the price of the item found on the ShopItem_YYY entityDef.

	=== Numbering ===		=== Numbering ===