BlueGit

timfa questward

Files

questward / shared / definitions / jewelryItems.js

jewelryItems.js

jewelryItems.js 7.1 KiB Download Raw
1import { ItemCategory } from "./itemCategories.js";
2import
3 {
4 GemTier,
5 GEM_TIER_ORDER,
6 GatherMaterialId,
7 MATERIAL_DISPLAY_NAME,
8 clothTierForGem,
9 tierMinSkillLevel,
10 tierRank
11 } from "./materialTiers.js";
12import { EquipmentKind } from "./equipmentKinds.js";
13import { CraftingStationId } from "./craftingStations.js";
14import { MetalItemId } from "./metalItems.js";
15import { cutGemItemId } from "./gemItems.js";
16import { yarnItemId } from "./clothItems.js";
17import { SkillId } from "./skills.js";
18import { equipImageName } from "./tileSprites.js";
19
20/**
21 * Jewellery pieces (ring / bracelet / amulet) set at the jewelering station.
22 * Metal: silver (gem tiers 1–3), gold (4–6), electrum (7).
23 * Inputs: 1 bar + 1 cut gem; amulets also need 1 matching-tier yarn.
24 * Tint: red = metal, blue = gem, green = yarn (amulet only).
25 * Descriptions are filled once unique effects are authored.
26 */
27
28export const JewelryPiece = Object.freeze({
29 ring: "ring",
30 bracelet: "bracelet",
31 amulet: "amulet"
32});
33
34export const JEWELRY_PIECE_ORDER = Object.freeze([
35 JewelryPiece.ring,
36 JewelryPiece.bracelet,
37 JewelryPiece.amulet
38]);
39
40/** Item IDs 561–581: rings, bracelets, amulets × 7 gem tiers. */
41export const JewelryItemId = Object.freeze({
42 tourmalineRing: 561,
43 alexandriteRing: 562,
44 opalRing: 563,
45 diamondRing: 564,
46 emeraldRing: 565,
47 rubyRing: 566,
48 jadeiteRing: 567,
49 tourmalineBracelet: 568,
50 alexandriteBracelet: 569,
51 opalBracelet: 570,
52 diamondBracelet: 571,
53 emeraldBracelet: 572,
54 rubyBracelet: 573,
55 jadeiteBracelet: 574,
56 tourmalineAmulet: 575,
57 alexandriteAmulet: 576,
58 opalAmulet: 577,
59 diamondAmulet: 578,
60 emeraldAmulet: 579,
61 rubyAmulet: 580,
62 jadeiteAmulet: 581
63});
64
65const RING_BY_GEM = Object.freeze({
66 [GemTier.tourmaline]: JewelryItemId.tourmalineRing,
67 [GemTier.alexandrite]: JewelryItemId.alexandriteRing,
68 [GemTier.opal]: JewelryItemId.opalRing,
69 [GemTier.diamond]: JewelryItemId.diamondRing,
70 [GemTier.emerald]: JewelryItemId.emeraldRing,
71 [GemTier.ruby]: JewelryItemId.rubyRing,
72 [GemTier.jadeite]: JewelryItemId.jadeiteRing
73});
74
75const BRACELET_BY_GEM = Object.freeze({
76 [GemTier.tourmaline]: JewelryItemId.tourmalineBracelet,
77 [GemTier.alexandrite]: JewelryItemId.alexandriteBracelet,
78 [GemTier.opal]: JewelryItemId.opalBracelet,
79 [GemTier.diamond]: JewelryItemId.diamondBracelet,
80 [GemTier.emerald]: JewelryItemId.emeraldBracelet,
81 [GemTier.ruby]: JewelryItemId.rubyBracelet,
82 [GemTier.jadeite]: JewelryItemId.jadeiteBracelet
83});
84
85const AMULET_BY_GEM = Object.freeze({
86 [GemTier.tourmaline]: JewelryItemId.tourmalineAmulet,
87 [GemTier.alexandrite]: JewelryItemId.alexandriteAmulet,
88 [GemTier.opal]: JewelryItemId.opalAmulet,
89 [GemTier.diamond]: JewelryItemId.diamondAmulet,
90 [GemTier.emerald]: JewelryItemId.emeraldAmulet,
91 [GemTier.ruby]: JewelryItemId.rubyAmulet,
92 [GemTier.jadeite]: JewelryItemId.jadeiteAmulet
93});
94
95export function jewelryMetalIdForGemTier (gemTier)
96{
97 const rank = tierRank(gemTier);
98 if (rank <= 3)
99 { return GatherMaterialId.silver; }
100 if (rank <= 6)
101 { return GatherMaterialId.gold; }
102 return GatherMaterialId.electrum;
103}
104
105export function jewelryMetalBarItemId (metalId)
106{
107 if (metalId === GatherMaterialId.electrum)
108 { return MetalItemId.electrumBar; }
109 if (metalId === GatherMaterialId.gold)
110 { return MetalItemId.goldBar; }
111 return MetalItemId.silverBar;
112}
113
114export function jewelryItemIdFor (piece, gemTier)
115{
116 if (piece === JewelryPiece.ring)
117 { return RING_BY_GEM[gemTier] ?? null; }
118 if (piece === JewelryPiece.bracelet)
119 { return BRACELET_BY_GEM[gemTier] ?? null; }
120 if (piece === JewelryPiece.amulet)
121 { return AMULET_BY_GEM[gemTier] ?? null; }
122 return null;
123}
124
125function pieceEquipSlot (piece)
126{
127 if (piece === JewelryPiece.ring)
128 { return "ring"; }
129 if (piece === JewelryPiece.bracelet)
130 { return "bracelet"; }
131 return "amulet";
132}
133
134function pieceDisplayNoun (piece)
135{
136 if (piece === JewelryPiece.ring)
137 { return "ring"; }
138 if (piece === JewelryPiece.bracelet)
139 { return "bracelet"; }
140 return "amulet";
141}
142
143function buildPieceDefinitions (piece, byGem)
144{
145 const out = {};
146 for (const gemTier of GEM_TIER_ORDER)
147 {
148 const itemId = byGem[gemTier];
149 const metalId = jewelryMetalIdForGemTier(gemTier);
150 const clothTier = piece === JewelryPiece.amulet ? clothTierForGem(gemTier) : null;
151 const metalName = MATERIAL_DISPLAY_NAME[metalId] ?? metalId;
152 const gemName = MATERIAL_DISPLAY_NAME[gemTier] ?? gemTier;
153 const noun = pieceDisplayNoun(piece);
154 out[itemId] = Object.freeze({
155 itemId,
156 key: `${gemTier}-${piece}`,
157 displayName: `${metalName} ${gemName.toLowerCase()} ${noun}`,
158 /** Filled when unique worn effects are authored. */
159 description: "",
160 seedValue: tierRank(gemTier) * (piece === JewelryPiece.amulet ? 5 : 4),
161 stackable: false,
162 maxStackSize: 1,
163 uniqueInstance: false,
164 category: ItemCategory.finished,
165 iconKey: "jewelery",
166 defaultState: piece,
167 tier: gemTier,
168 gemTier,
169 metalTier: metalId,
170 ...(clothTier ? { clothTier } : {}),
171 tintFromTier: true,
172 dualTintFromTier: true,
173 jewelryTint: true,
174 equipment: Object.freeze({
175 slot: pieceEquipSlot(piece),
176 tier: gemTier,
177 kind: EquipmentKind.jewelry,
178 tintFromTier: true,
179 dualTintFromTier: true,
180 equipSprite: equipImageName("item", "jewelery", `${piece}-equip`)
181 }),
182 npcShopAllowed: true
183 });
184 }
185 return out;
186}
187
188export const JEWELRY_ITEM_DEFINITIONS = Object.freeze({
189 ...buildPieceDefinitions(JewelryPiece.ring, RING_BY_GEM),
190 ...buildPieceDefinitions(JewelryPiece.bracelet, BRACELET_BY_GEM),
191 ...buildPieceDefinitions(JewelryPiece.amulet, AMULET_BY_GEM)
192});
193
194/**
195 * Live jewelering recipes: 1 precious bar + 1 cut gem (+ 1 yarn for amulets).
196 * Metal quantity is always 1 (not gem-tier rank).
197 */
198export function jewelryCraftRecipes ()
199{
200 const out = [];
201 for (const piece of JEWELRY_PIECE_ORDER)
202 {
203 const noun = pieceDisplayNoun(piece);
204 const label = noun.charAt(0).toUpperCase() + noun.slice(1);
205 for (const gemTier of GEM_TIER_ORDER)
206 {
207 const metalId = jewelryMetalIdForGemTier(gemTier);
208 const inputs = [
209 { itemId: jewelryMetalBarItemId(metalId), quantity: 1 },
210 { itemId: cutGemItemId(gemTier), quantity: 1 }
211 ];
212 if (piece === JewelryPiece.amulet)
213 { inputs.push({ itemId: yarnItemId(clothTierForGem(gemTier)), quantity: 1 }); }
214 out.push(Object.freeze({
215 recipeId: `${piece}-${gemTier}`,
216 craftGroup: piece,
217 craftGroupLabel: label,
218 stationId: CraftingStationId.jeweleringStation,
219 output: { itemId: jewelryItemIdFor(piece, gemTier), quantity: 1 },
220 inputs,
221 minSkillLevel: tierMinSkillLevel(gemTier),
222 skillId: SkillId.jewelering,
223 xpMaterial: gemTier
224 }));
225 }
226 }
227 return out;
228}
229
230/** @deprecated Prefer {@link jewelryCraftRecipes}; kept for callers that listed metal/gem pairing. */
231export const JEWELRY_RECIPE_GUIDELINES = Object.freeze(
232 GEM_TIER_ORDER.map((gemTier) =>
233 {
234 const metalId = jewelryMetalIdForGemTier(gemTier);
235 return Object.freeze({
236 tier: tierRank(gemTier),
237 gemTier,
238 cutGemItemId: cutGemItemId(gemTier),
239 metalId,
240 metalBarItemId: jewelryMetalBarItemId(metalId),
241 metalQuantity: 1,
242 yarnItemId: yarnItemId(clothTierForGem(gemTier)),
243 stationId: CraftingStationId.jeweleringStation,
244 skillId: SkillId.jewelering,
245 minSkillLevel: tierMinSkillLevel(gemTier)
246 });
247 })
248);