BlueGit

timfa questward

Files

questward / shared / definitions / items.js

items.js

items.js 13.8 KiB Download Raw
1import { equipImageName, spriteImageName } from "./tileSprites.js";
2import { SkillId } from "./skills.js";
3import { MaterialTier } from "./materialTiers.js";
4import { AttackType } from "./attackTypes.js";
5import { EquipmentKind } from "./equipmentKinds.js";
6import { formatQuantity } from "../items/formatQuantity.js";
7import { formatOriginBreakdown } from "../items/origin.js";
8import { CraftingItemId, CRAFTING_ITEM_STUBS } from "./craftingItems.js";
9import { MetalItemId, METAL_ITEM_DEFINITIONS } from "./metalItems.js";
10import { WoodItemId, WOOD_ITEM_DEFINITIONS } from "./woodItems.js";
11import { ArmourItemId, ARMOUR_ITEM_DEFINITIONS } from "./armourItems.js";
12import { ClothItemId, CLOTH_ITEM_DEFINITIONS } from "./clothItems.js";
13import { DyeItemId, FLOWER_ITEM_DEFINITION, DYE_ITEM_DEFINITION, FLOWER_COLOR_DISPLAY } from "./dyes.js";
14import { POTION_MAX_STACK } from "./alchemy.js";
15
16export const ItemId = Object.freeze({
17 paper: 1,
18 apple: 2,
19 stick: 3,
20 blankCheque: 4,
21 clothShirt: 5,
22 letter: 6,
23 filledCheque: 7,
24 coins: 8,
25 ...CraftingItemId,
26 lantern: 26,
27 bones: 27,
28 skull: 28,
29 glassBottle: 29,
30 greenHerb: 30,
31 redBeet: 31,
32 potion: 32,
33 recipePaper: 33,
34 bronzePlantClippers: 34,
35 ...MetalItemId,
36 ...WoodItemId,
37 ...ArmourItemId,
38 ...ClothItemId,
39 ...DyeItemId
40});
41
42export const EQUIPMENT_SLOT = Object.freeze({
43 head: "head",
44 chest: "chest",
45 legs: "legs",
46 boots: "boots",
47 weapon: "weapon",
48 offhand: "offhand"
49});
50
51export const EQUIPMENT_DRAW_ORDER = Object.freeze([
52 EQUIPMENT_SLOT.boots,
53 EQUIPMENT_SLOT.legs,
54 EQUIPMENT_SLOT.chest,
55 EQUIPMENT_SLOT.head,
56 EQUIPMENT_SLOT.offhand,
57 EQUIPMENT_SLOT.weapon
58]);
59
60export const DEFAULT_MAX_STACK = 99;
61export const BLANK_CHEQUE_CARRY_CAP = 99;
62export const COIN_MAX_STACK = 999_000_000_000;
63
64/** Coin sprite tiers (coins-<n>.png); pick the largest n where stack quantity >= n. */
65export const COIN_SPRITE_TIERS = Object.freeze([
66 1, 5, 15, 50, 150, 500, 1000, 1500, 2000, 5000, 10000, 20000, 50000,
67 1_000_000, 10_000_000, 50_000_000, 100_000_000, 500_000_000,
68 1_000_000_000, 10_000_000_000, 100_000_000_000, 1_000_000_000_000,
69 10_000_000_000_000, 100_000_000_000_000, 500_000_000_000_000,
70 999_999_999_999_999
71]);
72
73export const ITEM_DEFINITIONS = Object.freeze({
74 [ItemId.paper]: Object.freeze({
75 itemId: ItemId.paper,
76 key: "paper",
77 displayName: "Paper",
78 description: "Blank sheet of paper.",
79 seedValue: 2,
80 stackable: true,
81 maxStackSize: DEFAULT_MAX_STACK,
82 uniqueInstance: false,
83 category: "document"
84 }),
85 [ItemId.letter]: Object.freeze({
86 itemId: ItemId.letter,
87 key: "letter",
88 displayName: "Letter",
89 description: "A written letter.",
90 seedValue: 2,
91 stackable: false,
92 maxStackSize: 1,
93 uniqueInstance: true,
94 category: "document",
95 defaultState: "letter-opened"
96 }),
97 [ItemId.apple]: Object.freeze({
98 itemId: ItemId.apple,
99 key: "apple",
100 displayName: "Apple",
101 description: "Round and juicy!",
102 seedValue: 1,
103 stackable: true,
104 maxStackSize: DEFAULT_MAX_STACK,
105 uniqueInstance: false,
106 category: "food",
107 healing: 4
108 }),
109 [ItemId.stick]: Object.freeze({
110 itemId: ItemId.stick,
111 key: "stick",
112 displayName: "Stick",
113 description: "A wooden stick. Simple and sturdy.",
114 seedValue: 3,
115 stackable: false,
116 maxStackSize: 1,
117 uniqueInstance: false,
118 category: "finished",
119 equipment: Object.freeze({
120 slot: EQUIPMENT_SLOT.weapon,
121 tier: MaterialTier.bronze,
122 kind: EquipmentKind.clubWeapon,
123 attack: Object.freeze({
124 mode: "melee",
125 rangeTiles: 1,
126 hitSkillId: SkillId.clubfighting,
127 damageSkillId: SkillId.strength,
128 attackType: AttackType.blunt,
129 cooldownMs: 700,
130 baseDamage: 2
131 })
132 })
133 }),
134 [ItemId.blankCheque]: Object.freeze({
135 itemId: ItemId.blankCheque,
136 key: "blank-cheque",
137 displayName: "Blank cheque",
138 description: "Free bank paper. Write a cheque to reserve vault goods.",
139 seedValue: 5,
140 stackable: true,
141 maxStackSize: DEFAULT_MAX_STACK,
142 uniqueInstance: false,
143 category: "document",
144 marketplaceSellable: false,
145 marketplaceSellBlockedReason: "Blank cheques cannot be sold on the marketplace."
146 }),
147 [ItemId.filledCheque]: Object.freeze({
148 itemId: ItemId.filledCheque,
149 key: "filled-cheque",
150 displayName: "Cheque",
151 description: "A bearer cheque linked to reserved goods in the issuer's bank.",
152 seedValue: 5,
153 stackable: false,
154 maxStackSize: 1,
155 uniqueInstance: true,
156 category: "document",
157 defaultState: "filled-cheque",
158 marketplaceSellable: true
159 }),
160 [ItemId.clothShirt]: Object.freeze({
161 itemId: ItemId.clothShirt,
162 key: "cloth-shirt",
163 displayName: "Cloth shirt",
164 description: "A placeholder shirt worn on the chest.",
165 seedValue: 8,
166 stackable: false,
167 maxStackSize: 1,
168 uniqueInstance: false,
169 category: "finished",
170 equipment: Object.freeze({
171 slot: EQUIPMENT_SLOT.chest,
172 tier: MaterialTier.bronze,
173 kind: EquipmentKind.clothArmour
174 })
175 }),
176 [ItemId.coins]: Object.freeze({
177 itemId: ItemId.coins,
178 key: "coins",
179 displayName: "Coin",
180 displayNamePlural: "Coins",
181 description: "Currency carried in your bag.",
182 seedValue: 1,
183 stackable: true,
184 maxStackSize: COIN_MAX_STACK,
185 uniqueInstance: false,
186 category: "currency"
187 }),
188 [ItemId.lantern]: Object.freeze({
189 itemId: ItemId.lantern,
190 key: "lantern",
191 displayName: "Lantern",
192 description: "A handheld light source. Equip in the offhand to illuminate your surroundings at night.",
193 seedValue: 12,
194 stackable: false,
195 maxStackSize: 1,
196 uniqueInstance: false,
197 category: "tool",
198 equipment: Object.freeze({
199 slot: EQUIPMENT_SLOT.offhand,
200 lightRadiusTiles: 6
201 })
202 }),
203 [ItemId.bones]: Object.freeze({
204 itemId: ItemId.bones,
205 key: "bones",
206 displayName: "Bones",
207 description: "Bones of a dead creature.",
208 seedValue: 1,
209 stackable: true,
210 maxStackSize: DEFAULT_MAX_STACK,
211 uniqueInstance: false,
212 category: "ingredient"
213 }),
214 [ItemId.skull]: Object.freeze({
215 itemId: ItemId.skull,
216 key: "skull",
217 displayName: "Skull",
218 description: "Unlucky.",
219 seedValue: 1,
220 stackable: true,
221 maxStackSize: DEFAULT_MAX_STACK,
222 uniqueInstance: false,
223 category: "misc"
224 }),
225 [ItemId.glassBottle]: Object.freeze({
226 itemId: ItemId.glassBottle,
227 key: "glass-bottle",
228 displayName: "Glass bottle",
229 description: "An empty bottle for potions and dyes.",
230 seedValue: 2,
231 stackable: true,
232 maxStackSize: DEFAULT_MAX_STACK,
233 uniqueInstance: false,
234 category: "tool",
235 iconKey: "potion",
236 defaultState: "potion-0",
237 npcShopAllowed: true
238 }),
239 [ItemId.greenHerb]: Object.freeze({
240 itemId: ItemId.greenHerb,
241 key: "green-herb",
242 displayName: "Green herb",
243 description: "A common herb. Gathered with plant clippers.",
244 seedValue: 2,
245 stackable: true,
246 maxStackSize: DEFAULT_MAX_STACK,
247 uniqueInstance: false,
248 category: "ingredient"
249 }),
250 [ItemId.redBeet]: Object.freeze({
251 itemId: ItemId.redBeet,
252 key: "red-beet",
253 displayName: "Red beet",
254 description: "A root vegetable.",
255 seedValue: 1,
256 stackable: true,
257 maxStackSize: DEFAULT_MAX_STACK,
258 uniqueInstance: false,
259 category: "ingredient"
260 }),
261 [ItemId.potion]: Object.freeze({
262 itemId: ItemId.potion,
263 key: "potion",
264 displayName: "Potion",
265 description: "A bottled brew. Drink to apply its effect (effects TBD).",
266 seedValue: 8,
267 stackable: true,
268 maxStackSize: POTION_MAX_STACK,
269 uniqueInstance: false,
270 category: "potion",
271 potion: true,
272 iconKey: "potion"
273 }),
274 [ItemId.recipePaper]: Object.freeze({
275 itemId: ItemId.recipePaper,
276 key: "recipe-paper",
277 displayName: "Recipe paper",
278 description: "An alchemy recipe.",
279 seedValue: 2,
280 stackable: false,
281 maxStackSize: 1,
282 uniqueInstance: true,
283 category: "document",
284 defaultState: "recipe-paper",
285 iconKey: "paper"
286 }),
287 [ItemId.bronzePlantClippers]: Object.freeze({
288 itemId: ItemId.bronzePlantClippers,
289 key: "bronze-plant-clippers",
290 displayName: "Bronze plant clippers",
291 description: "Use this to gather herbs and flowers.",
292 seedValue: 10,
293 stackable: false,
294 maxStackSize: 1,
295 uniqueInstance: false,
296 category: "tool",
297 npcShopAllowed: true,
298 equipment: Object.freeze({
299 slot: EQUIPMENT_SLOT.weapon,
300 tier: MaterialTier.bronze,
301 kind: EquipmentKind.plantClippers,
302 tintFromTier: true
303 })
304 }),
305 ...CRAFTING_ITEM_STUBS,
306 ...METAL_ITEM_DEFINITIONS,
307 ...WOOD_ITEM_DEFINITIONS,
308 ...ARMOUR_ITEM_DEFINITIONS,
309 ...CLOTH_ITEM_DEFINITIONS,
310 [DyeItemId.flower]: FLOWER_ITEM_DEFINITION,
311 [DyeItemId.dye]: DYE_ITEM_DEFINITION
312});
313
314export function itemDefinition (itemId)
315{
316 return ITEM_DEFINITIONS[itemId] ?? null;
317}
318
319export { formatQuantity };
320
321export function itemDisplayName (stack, def = itemDefinition(stack?.itemId))
322{
323 if (!def)
324 { return "Item"; }
325 const qty = stack?.quantity ?? 1;
326 if (stack?.itemId === ItemId.coins)
327 { return qty === 1 ? (def.displayName ?? "Coin") : (def.displayNamePlural ?? "Coins"); }
328 if (stack?.itemId === ItemId.potion && stack.instance?.displayName)
329 { return stack.instance.displayName; }
330 if (stack?.itemId === ItemId.dye && stack.instance?.kind === "dye")
331 { return "Dye"; }
332 if (stack?.itemId === ItemId.flower && stack.instance?.colorId)
333 {
334 return `${FLOWER_COLOR_DISPLAY[stack.instance.colorId] ?? "Flower"} flower`;
335 }
336 if (stack?.itemId === ItemId.recipePaper && stack.instance?.displayName)
337 { return stack.instance.displayName; }
338 return def.displayName ?? "Item";
339}
340
341export function stackDisplayLabel (stack)
342{
343 const name = itemDisplayName(stack);
344 const qty = stack?.quantity ?? 1;
345 if (qty <= 1)
346 { return name; }
347 return `${name} (${formatQuantity(qty)})`;
348}
349
350export function coinSpriteTierForQuantity (quantity)
351{
352 const qty = Math.max(0, Math.floor(Number(quantity) || 0));
353 let tier = COIN_SPRITE_TIERS[0];
354 for (const candidate of COIN_SPRITE_TIERS)
355 {
356 if (qty >= candidate)
357 { tier = candidate; }
358 else
359 { break; }
360 }
361 return tier;
362}
363
364/** Stack-aware description (letters include open state and author). */
365export function itemDescription (stack, { localCharacterId } = {})
366{
367 const def = itemDefinition(stack?.itemId);
368 if (!def)
369 { return ""; }
370 if (stack.itemId === ItemId.letter && stack.instance?.kind === "letter")
371 {
372 const state = stack.instance.opened === false ? "unopened" : "opened";
373 const authorId = stack.instance.authorCharacterId;
374 const byYou = authorId != null && Number(authorId) === Number(localCharacterId);
375 const author = byYou
376 ? "you"
377 : (stack.instance.authorDisplayName?.trim() || "someone");
378 return `An ${state} letter, written by ${author}.`;
379 }
380 if (stack.itemId === ItemId.filledCheque && stack.instance?.kind === "filled-cheque")
381 {
382 const reserved = itemDefinition(stack.instance.itemId);
383 const qty = stack.instance.quantity | 0;
384 const name = reserved?.displayName ?? "goods";
385 return `Bearer cheque for ${qty}× ${name}.`;
386 }
387 if (stack.itemId === ItemId.potion && stack.instance?.kind === "potion")
388 {
389 const name = stack.instance.displayName ?? "Potion";
390 return stack.instance.unstable
391 ? `${name}. An unstable brew — effects are unpredictable.`
392 : `${name}. Drink to apply its effect.`;
393 }
394 if (stack.itemId === ItemId.recipePaper && stack.instance?.kind === "recipe-paper")
395 { return "An alchemy recipe."; }
396 return def.description ?? "";
397}
398
399export function itemOriginSummary (stack)
400{
401 return formatOriginBreakdown(stack);
402}
403
404export function itemDefaultState (def)
405{
406 return def?.defaultState ?? def?.key ?? "paper";
407}
408
409export function itemSpriteName (itemId, instance = null)
410{
411 const def = itemDefinition(itemId);
412 if (!def)
413 { return spriteImageName("item", "paper", "paper"); }
414 if (itemId === ItemId.letter)
415 { return spriteImageName("item", "letter", letterVisualState(instance)); }
416 const folderKey = def.iconKey ?? def.key;
417 return def.sprite ?? spriteImageName("item", folderKey, itemDefaultState(def));
418}
419
420export function itemEquipSprite (itemId)
421{
422 const def = itemDefinition(itemId);
423 const equipment = def?.equipment;
424 if (!equipment)
425 { return null; }
426 const folderKey = def.iconKey ?? def.key;
427 return equipment.equipSprite
428 ?? equipment.overlaySpriteId
429 ?? equipImageName("item", folderKey, itemDefaultState(def));
430}
431
432/** Largest equipped light radius (e.g. lantern in offhand). */
433export function equippedLightRadiusTiles (equipment)
434{
435 let best = 0;
436 for (const stack of Object.values(equipment?.slots ?? {}))
437 {
438 if (!stack)
439 { continue; }
440 const radius = itemDefinition(stack.itemId)?.equipment?.lightRadiusTiles ?? 0;
441 if (radius > best)
442 { best = radius; }
443 }
444 return best;
445}
446
447export function letterVisualState (instance)
448{
449 return instance?.opened === false ? "letter-closed" : "letter-opened";
450}
451
452export function itemAssetPath (itemId, companion = null, instance = null)
453{
454 const def = itemDefinition(itemId);
455 const key = def?.iconKey ?? def?.key ?? "paper";
456 const state = itemId === ItemId.letter
457 ? letterVisualState(instance)
458 : itemDefaultState(def ?? { key });
459 const suffix = companion ? `-${companion}` : "";
460 return `/assets/items/${key}/${state}${suffix}.png`;
461}
462
463export function itemAssetPathForStack (stack)
464{
465 if (!stack)
466 { return itemAssetPath(null); }
467 if (stack.itemId === ItemId.coins)
468 {
469 const tier = coinSpriteTierForQuantity(stack.quantity);
470 return `/assets/items/coins/coins-${tier}.png`;
471 }
472 if (stack.itemId === ItemId.potion)
473 {
474 const fill = Math.max(1, Math.min(5, stack.instance?.fillLevel | 0 || 4));
475 return `/assets/items/potion/potion-${fill}.png`;
476 }
477 if (stack.itemId === ItemId.dye)
478 {
479 const fill = Math.max(1, Math.min(5, stack.instance?.fillLevel | 0 || 4));
480 return `/assets/items/potion/potion-${fill}.png`;
481 }
482 if (stack.itemId === ItemId.glassBottle)
483 { return `/assets/items/potion/potion-0.png`; }
484 if (stack.itemId === ItemId.flower)
485 { return `/assets/items/flower/flower.png`; }
486 return itemAssetPath(stack.itemId, null, stack.instance);
487}
488
489export const LETTER_MAX_BODY_CHARS = 2000;
490
491export const STARTER_ITEMS = Object.freeze([
492 Object.freeze({ itemId: ItemId.paper, quantity: 5 }),
493 Object.freeze({ itemId: ItemId.apple, quantity: 3 }),
494 Object.freeze({ itemId: ItemId.stick, quantity: 1 }),
495 Object.freeze({ itemId: ItemId.clothShirt, quantity: 1 }),
496 Object.freeze({ itemId: ItemId.coins, quantity: 25 })
497]);