Line 239: |
Line 239: |
| | | |
| ===Context tags=== | | ===Context tags=== |
− | A ''context tag'' is an arbitrary label attached to items, which can produce various effects in-game. | + | A ''context tag'' is an arbitrary data label attached to items. These can produce various effects in-game, or may be informational only. |
| | | |
− | Every item has built-in tags for metadata like the item name, quality, and category. Further context tags are defined in <samp>Data/ObjectContextTags</samp>, which consists of a string→string dictionary (where the key is the item's internal name, and the value is a comma-delimited list of tags to add):
| + | The game generates some tags based on the game data (like the item quality), and others are defined in the <samp>Data/ObjectContextTags</samp> data asset (which consists of a string→string dictionary, where the key is the item's internal name, and the value is a comma-delimited list of tags to add). |
− | <syntaxhighlight lang="json">
| + | |
− | "Chanterelle": "color_brown, forage_item, forage_item_cave, forage_item_secret, season_fall",
| + | Here's an ''incomplete'' list of context tags added or used in the base game. Mods can add custom context tags, which aren't listed here. |
− | </syntaxhighlight>
| |
| | | |
− | Context tags have a variety of effects in-game:
| |
| {| class="wikitable" | | {| class="wikitable" |
| |- | | |- |
− | ! feature | + | ! context tag |
− | ! effects | + | ! effect |
− | |-
| |
− | | [[Fish Pond|fish ponds]]
| |
− | | Context tags determine what the fish will produce and other elements. See [[Modding:Fish Pond data#RequiredTags|Fish pond tags]] for more info.
| |
| |- | | |- |
− | | [[Quests#List of Special Orders|special orders]] | + | | <samp>color_*</samp> |
− | | Contexts tags are used in special orders to determine what are the valid items for the quest objective(s). | + | | The color produced by this item when the player [[Dyeing#Dye Pots|dyes clothing]] at [[2 Willow Lane|Emily's house]]. The context tag only affects which of the six color dye pots it can be placed in; for example, <samp>color_red</samp> and <samp>color_dark_red</samp> are both placed in the red pot, but they don't produce different colors. |
− | |-
| |
− | | [[Dyeing|dyeing]]
| |
− | | Contexts tags are used to determine the color of dye an item produces.
| |
− | |}
| |
− | | |
− | The <samp>debug listtags</samp> [[Modding:Console commands|console command]] lists all the tags of the item being held.
| |
− | | |
− | Here is a list of context tags extracted from ''ObjectContextTags.json'': <samp>alcohol_item</samp>, <samp>algae_item</samp>, <samp>ancient_item</samp>, <samp>beach_item</samp>, <samp>bomb_item</samp>, <samp>bone_item</samp>, <samp>book_item</samp>, <samp>ceramic_item</samp>, <samp>chicken_item</samp>, <samp>color_aquamarine</samp>, <samp>color_black</samp>, <samp>color_blue</samp>, <samp>color_brown</samp>, <samp>color_copper</samp>, <samp>color_cyan</samp>, <samp>color_dark_blue</samp>, <samp>color_dark_brown</samp>, <samp>color_dark_gray</samp>, <samp>color_dark_green</samp>, <samp>color_dark_pink</samp>, <samp>color_dark_purple</samp>, <samp>color_dark_red</samp>, <samp>color_dark_yellow</samp>, <samp>color_gold</samp>, <samp>color_gray</samp>, <samp>color_green</samp>, <samp>color_iridium</samp>, <samp>color_iron</samp>, <samp>color_jade</samp>, <samp>color_light_cyan</samp>, <samp>color_lime</samp>, <samp>color_orange</samp>, <samp>color_pale_violet_red</samp>, <samp>color_pink</samp>, <samp>color_poppyseed</samp>, <samp>color_prismatic</samp>, <samp>color_purple</samp>, <samp>color_red</samp>, <samp>color_salmon</samp>, <samp>color_sand</samp>, <samp>color_white</samp>, <samp>color_yellow</samp>, <samp>color_yellow_green</samp>, <samp>cooking_item</samp>, <samp>cow_milk_item</samp>, <samp>cowboy_item</samp>, <samp>crop_year_2</samp>, <samp>dinosaur_item</samp>, <samp>doll_item</samp>, <samp>drink_item</samp>, <samp>dwarvish_item</samp>, <samp>dye_medium</samp>, <samp>dye_strong</samp>, <samp>egg_item</samp>, <samp>elvish_item</samp>, <samp>fertilizer_item</samp>, <samp>fish_bug_lair</samp>, <samp>fish_carnivorous</samp>, <samp>fish_crab_pot</samp>, <samp>fish_desert</samp>, <samp>fish_freshwater</samp>, <samp>fish_lake</samp>, <samp>fish_legendary</samp>, <samp>fish_mines</samp>, <samp>fish_night_market</samp>, <samp>fish_nonfish</samp>, <samp>fish_ocean</samp>, <samp>fish_pond</samp>, <samp>fish_river</samp>, <samp>fish_secret_pond</samp>, <samp>fish_semi_rare</samp>, <samp>fish_sewers</samp>, <samp>fish_swamp</samp>, <samp>fish_talk_demanding</samp>, <samp>fish_talk_rude</samp>, <samp>fish_talk_stiff</samp>, <samp>fish_upright</samp>, <samp>flower_item</samp>, <samp>food_bakery</samp>, <samp>food_breakfast</samp>, <samp>food_cake</samp>, <samp>food_party</samp>, <samp>food_pasta</samp>, <samp>food_salad</samp>, <samp>food_sauce</samp>, <samp>food_seafood</samp>, <samp>food_soup</samp>, <samp>food_spicy</samp>, <samp>food_sushi</samp>, <samp>food_sweet</samp>, <samp>forage_item</samp>, <samp>forage_item_beach</samp>, <samp>forage_item_cave</samp>, <samp>forage_item_desert</samp>, <samp>forage_item_mines</samp>, <samp>forage_item_secret</samp>, <samp>fossil_item</samp>, <samp>fruit_item</samp>, <samp>fruit_tree_item</samp>, <samp>furnace_item</samp>, <samp>ginger_item</samp>, <samp>goat_milk_item</samp>, <samp>golden_relic_item</samp>, <samp>honey_item</samp>, <samp>hunting_item</samp>, <samp>instrument_item</samp>, <samp>jelly_item</samp>, <samp>juice_item</samp>, <samp>large_egg_item</samp>, <samp>large_milk_item</samp>, <samp>light_source</samp>, <samp>machine_item</samp>, <samp>marine_item</samp>, <samp>mayo_item</samp>, <samp>medicine_item</samp>, <samp>milk_item</samp>, <samp>noble_item</samp>, <samp>ore_item</samp>, <samp>pickle_item</samp>, <samp>potion_item</samp>, <samp>prehistoric_item</samp>, <samp>quality_fertilizer_item</samp>, <samp>scroll_item</samp>, <samp>season_all</samp>, <samp>season_fall</samp>, <samp>season_spring</samp>, <samp>season_summer</samp>, <samp>season_winter</samp>, <samp>slime_egg_item</samp>, <samp>slime_item</samp>, <samp>statue_item</samp>, <samp>strange_doll_1</samp>, <samp>strange_doll_2</samp>, <samp>syrup_item</samp>, <samp>totem_item</samp>, <samp>toy_item</samp>, <samp>trash_item</samp>, <samp>tree_seed_item</samp>, <samp>wood_item</samp>
| |
− | | |
− | Each of the [[Dyeing#Dye_Pots|six dye pot colors]] in [[2_Willow_Lane|Emily's house]] group together several color context tags:
| |
| | | |
| {| class="wikitable" | | {| class="wikitable" |
| |- | | |- |
− | ! dye pot color | + | ! dye pot |
− | ! color context tags | + | ! context tags |
| |- | | |- |
− | | Red | + | | red |
| | <samp>color_red</samp>, <samp>color_salmon</samp>, <samp>color_dark_red</samp>, <samp>color_pink</samp> | | | <samp>color_red</samp>, <samp>color_salmon</samp>, <samp>color_dark_red</samp>, <samp>color_pink</samp> |
| |- | | |- |
− | | Orange | + | | orange |
| | <samp>color_orange</samp>, <samp>color_dark_orange</samp>, <samp>color_dark_brown</samp>, <samp>color_brown</samp>, <samp>color_copper</samp> | | | <samp>color_orange</samp>, <samp>color_dark_orange</samp>, <samp>color_dark_brown</samp>, <samp>color_brown</samp>, <samp>color_copper</samp> |
| |- | | |- |
− | | Yellow | + | | yellow |
| | <samp>color_yellow</samp>, <samp>color_dark_yellow</samp>, <samp>color_gold</samp>, <samp>color_sand</samp> | | | <samp>color_yellow</samp>, <samp>color_dark_yellow</samp>, <samp>color_gold</samp>, <samp>color_sand</samp> |
| |- | | |- |
− | | Green | + | | green |
| | <samp>color_green</samp>, <samp>color_dark_green</samp>, <samp>color_lime</samp>, <samp>color_yellow_green</samp>, <samp>color_jade</samp> | | | <samp>color_green</samp>, <samp>color_dark_green</samp>, <samp>color_lime</samp>, <samp>color_yellow_green</samp>, <samp>color_jade</samp> |
| |- | | |- |
− | | Blue | + | | blue |
| | <samp>color_blue</samp>, <samp>color_dark_blue</samp>, <samp>color_dark_cyan</samp>, <samp>color_light_cyan</samp>, <samp>color_cyan</samp>, <samp>color_aquamarine</samp> | | | <samp>color_blue</samp>, <samp>color_dark_blue</samp>, <samp>color_dark_cyan</samp>, <samp>color_light_cyan</samp>, <samp>color_cyan</samp>, <samp>color_aquamarine</samp> |
| |- | | |- |
− | | Purple | + | | purple |
| | <samp>color_purple</samp>, <samp>color_dark_purple</samp>, <samp>color_dark_pink</samp>, <samp>color_pale_violet_red</samp>, <samp>color_poppyseed</samp>, <samp>color_iridium</samp> | | | <samp>color_purple</samp>, <samp>color_dark_purple</samp>, <samp>color_dark_pink</samp>, <samp>color_pale_violet_red</samp>, <samp>color_poppyseed</samp>, <samp>color_iridium</samp> |
| + | |} |
| |} | | |} |
| | | |
− | For example, since chanterelle items have the <samp>color_brown</samp> context tag and that is in the Orange category, chanterelles can be placed in the orange dye pot.
| + | Context tags have a variety of effects in-game: |
| + | {| class="wikitable" |
| + | |- |
| + | ! feature |
| + | ! effects |
| + | |- |
| + | | [[Fish Pond|fish ponds]] |
| + | | Context tags determine what the fish will produce and other elements. See [[Modding:Fish Pond data#RequiredTags|Fish pond tags]] for more info. |
| + | |- |
| + | | [[Quests#List of Special Orders|special orders]] |
| + | | Contexts tags are used in special orders to determine what are the valid items for the quest objective(s). |
| + | |} |
| + | |
| + | The <samp>debug listtags</samp> [[Modding:Console commands|console command]] lists all the tags of the item being held. |
| | | |
− | (This dye pot color information was extracted from ''DyeMenu.cs'' of the Stardew Valley source code.)
| + | {{collapse|raw tag dump|content=Here's a list of context tags extracted from <samp>Data/ObjectContextTags</samp>: <samp>alcohol_item</samp>, <samp>algae_item</samp>, <samp>ancient_item</samp>, <samp>beach_item</samp>, <samp>bomb_item</samp>, <samp>bone_item</samp>, <samp>book_item</samp>, <samp>ceramic_item</samp>, <samp>chicken_item</samp>, <samp>color_aquamarine</samp>, <samp>color_black</samp>, <samp>color_blue</samp>, <samp>color_brown</samp>, <samp>color_copper</samp>, <samp>color_cyan</samp>, <samp>color_dark_blue</samp>, <samp>color_dark_brown</samp>, <samp>color_dark_gray</samp>, <samp>color_dark_green</samp>, <samp>color_dark_pink</samp>, <samp>color_dark_purple</samp>, <samp>color_dark_red</samp>, <samp>color_dark_yellow</samp>, <samp>color_gold</samp>, <samp>color_gray</samp>, <samp>color_green</samp>, <samp>color_iridium</samp>, <samp>color_iron</samp>, <samp>color_jade</samp>, <samp>color_light_cyan</samp>, <samp>color_lime</samp>, <samp>color_orange</samp>, <samp>color_pale_violet_red</samp>, <samp>color_pink</samp>, <samp>color_poppyseed</samp>, <samp>color_prismatic</samp>, <samp>color_purple</samp>, <samp>color_red</samp>, <samp>color_salmon</samp>, <samp>color_sand</samp>, <samp>color_white</samp>, <samp>color_yellow</samp>, <samp>color_yellow_green</samp>, <samp>cooking_item</samp>, <samp>cow_milk_item</samp>, <samp>cowboy_item</samp>, <samp>crop_year_2</samp>, <samp>dinosaur_item</samp>, <samp>doll_item</samp>, <samp>drink_item</samp>, <samp>dwarvish_item</samp>, <samp>dye_medium</samp>, <samp>dye_strong</samp>, <samp>egg_item</samp>, <samp>elvish_item</samp>, <samp>fertilizer_item</samp>, <samp>fish_bug_lair</samp>, <samp>fish_carnivorous</samp>, <samp>fish_crab_pot</samp>, <samp>fish_desert</samp>, <samp>fish_freshwater</samp>, <samp>fish_lake</samp>, <samp>fish_legendary</samp>, <samp>fish_mines</samp>, <samp>fish_night_market</samp>, <samp>fish_nonfish</samp>, <samp>fish_ocean</samp>, <samp>fish_pond</samp>, <samp>fish_river</samp>, <samp>fish_secret_pond</samp>, <samp>fish_semi_rare</samp>, <samp>fish_sewers</samp>, <samp>fish_swamp</samp>, <samp>fish_talk_demanding</samp>, <samp>fish_talk_rude</samp>, <samp>fish_talk_stiff</samp>, <samp>fish_upright</samp>, <samp>flower_item</samp>, <samp>food_bakery</samp>, <samp>food_breakfast</samp>, <samp>food_cake</samp>, <samp>food_party</samp>, <samp>food_pasta</samp>, <samp>food_salad</samp>, <samp>food_sauce</samp>, <samp>food_seafood</samp>, <samp>food_soup</samp>, <samp>food_spicy</samp>, <samp>food_sushi</samp>, <samp>food_sweet</samp>, <samp>forage_item</samp>, <samp>forage_item_beach</samp>, <samp>forage_item_cave</samp>, <samp>forage_item_desert</samp>, <samp>forage_item_mines</samp>, <samp>forage_item_secret</samp>, <samp>fossil_item</samp>, <samp>fruit_item</samp>, <samp>fruit_tree_item</samp>, <samp>furnace_item</samp>, <samp>ginger_item</samp>, <samp>goat_milk_item</samp>, <samp>golden_relic_item</samp>, <samp>honey_item</samp>, <samp>hunting_item</samp>, <samp>instrument_item</samp>, <samp>jelly_item</samp>, <samp>juice_item</samp>, <samp>large_egg_item</samp>, <samp>large_milk_item</samp>, <samp>light_source</samp>, <samp>machine_item</samp>, <samp>marine_item</samp>, <samp>mayo_item</samp>, <samp>medicine_item</samp>, <samp>milk_item</samp>, <samp>noble_item</samp>, <samp>ore_item</samp>, <samp>pickle_item</samp>, <samp>potion_item</samp>, <samp>prehistoric_item</samp>, <samp>quality_fertilizer_item</samp>, <samp>scroll_item</samp>, <samp>season_all</samp>, <samp>season_fall</samp>, <samp>season_spring</samp>, <samp>season_summer</samp>, <samp>season_winter</samp>, <samp>slime_egg_item</samp>, <samp>slime_item</samp>, <samp>statue_item</samp>, <samp>strange_doll_1</samp>, <samp>strange_doll_2</samp>, <samp>syrup_item</samp>, <samp>totem_item</samp>, <samp>toy_item</samp>, <samp>trash_item</samp>, <samp>tree_seed_item</samp>, <samp>wood_item</samp>.}} |
| | | |
| ==Objects== | | ==Objects== |