BlueGit

timfa questward

Files

questward / shared / definitions / items.js

items.js

items.js 13.9 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 simple cloth shirt. Shared clothing/shirt art (tintable).",
165 seedValue: 8,
166 stackable: false,
167 maxStackSize: 1,
168 uniqueInstance: false,
169 category: "finished",
170 iconKey: "clothing",
171 defaultState: "shirt",
172 equipment: Object.freeze({
173 slot: EQUIPMENT_SLOT.chest,
174 tier: MaterialTier.bronze,
175 kind: EquipmentKind.clothArmour,
176 equipSprite: equipImageName("item", "clothing", "shirt")
177 })
178 }),
179 [ItemId.coins]: Object.freeze({
180 itemId: ItemId.coins,
181 key: "coins",
182 displayName: "Coin",
183 displayNamePlural: "Coins",
184 description: "Currency carried in your bag.",
185 seedValue: 1,
186 stackable: true,
187 maxStackSize: COIN_MAX_STACK,
188 uniqueInstance: false,
189 category: "currency"
190 }),
191 [ItemId.lantern]: Object.freeze({
192 itemId: ItemId.lantern,
193 key: "lantern",
194 displayName: "Lantern",
195 description: "A handheld light source. Equip in the offhand to illuminate your surroundings at night.",
196 seedValue: 12,
197 stackable: false,
198 maxStackSize: 1,
199 uniqueInstance: false,
200 category: "tool",
201 equipment: Object.freeze({
202 slot: EQUIPMENT_SLOT.offhand,
203 lightRadiusTiles: 6
204 })
205 }),
206 [ItemId.bones]: Object.freeze({
207 itemId: ItemId.bones,
208 key: "bones",
209 displayName: "Bones",
210 description: "Bones of a dead creature.",
211 seedValue: 1,
212 stackable: true,
213 maxStackSize: DEFAULT_MAX_STACK,
214 uniqueInstance: false,
215 category: "ingredient"
216 }),
217 [ItemId.skull]: Object.freeze({
218 itemId: ItemId.skull,
219 key: "skull",
220 displayName: "Skull",
221 description: "Unlucky.",
222 seedValue: 1,
223 stackable: true,
224 maxStackSize: DEFAULT_MAX_STACK,
225 uniqueInstance: false,
226 category: "misc"
227 }),
228 [ItemId.glassBottle]: Object.freeze({
229 itemId: ItemId.glassBottle,
230 key: "glass-bottle",
231 displayName: "Glass bottle",
232 description: "An empty bottle for potions and dyes.",
233 seedValue: 2,
234 stackable: true,
235 maxStackSize: DEFAULT_MAX_STACK,
236 uniqueInstance: false,
237 category: "tool",
238 iconKey: "potion",
239 defaultState: "potion-0",
240 npcShopAllowed: true
241 }),
242 [ItemId.greenHerb]: Object.freeze({
243 itemId: ItemId.greenHerb,
244 key: "green-herb",
245 displayName: "Green herb",
246 description: "A common herb. Gathered with plant clippers.",
247 seedValue: 2,
248 stackable: true,
249 maxStackSize: DEFAULT_MAX_STACK,
250 uniqueInstance: false,
251 category: "ingredient"
252 }),
253 [ItemId.redBeet]: Object.freeze({
254 itemId: ItemId.redBeet,
255 key: "red-beet",
256 displayName: "Red beet",
257 description: "A root vegetable.",
258 seedValue: 1,
259 stackable: true,
260 maxStackSize: DEFAULT_MAX_STACK,
261 uniqueInstance: false,
262 category: "ingredient"
263 }),
264 [ItemId.potion]: Object.freeze({
265 itemId: ItemId.potion,
266 key: "potion",
267 displayName: "Potion",
268 description: "A bottled brew. Drink to apply its effect (effects TBD).",
269 seedValue: 8,
270 stackable: true,
271 maxStackSize: POTION_MAX_STACK,
272 uniqueInstance: false,
273 category: "potion",
274 potion: true,
275 iconKey: "potion"
276 }),
277 [ItemId.recipePaper]: Object.freeze({
278 itemId: ItemId.recipePaper,
279 key: "recipe-paper",
280 displayName: "Recipe paper",
281 description: "An alchemy recipe.",
282 seedValue: 2,
283 stackable: false,
284 maxStackSize: 1,
285 uniqueInstance: true,
286 category: "document",
287 defaultState: "recipe-paper",
288 iconKey: "paper"
289 }),
290 [ItemId.bronzePlantClippers]: Object.freeze({
291 itemId: ItemId.bronzePlantClippers,
292 key: "bronze-plant-clippers",
293 displayName: "Bronze plant clippers",
294 description: "Use this to gather herbs and flowers.",
295 seedValue: 10,
296 stackable: false,
297 maxStackSize: 1,
298 uniqueInstance: false,
299 category: "tool",
300 npcShopAllowed: true,
301 equipment: Object.freeze({
302 slot: EQUIPMENT_SLOT.weapon,
303 tier: MaterialTier.bronze,
304 kind: EquipmentKind.plantClippers,
305 tintFromTier: true
306 })
307 }),
308 ...CRAFTING_ITEM_STUBS,
309 ...METAL_ITEM_DEFINITIONS,
310 ...WOOD_ITEM_DEFINITIONS,
311 ...ARMOUR_ITEM_DEFINITIONS,
312 ...CLOTH_ITEM_DEFINITIONS,
313 [DyeItemId.flower]: FLOWER_ITEM_DEFINITION,
314 [DyeItemId.dye]: DYE_ITEM_DEFINITION
315});
316
317export function itemDefinition (itemId)
318{
319 return ITEM_DEFINITIONS[itemId] ?? null;
320}
321
322export { formatQuantity };
323
324export function itemDisplayName (stack, def = itemDefinition(stack?.itemId))
325{
326 if (!def)
327 { return "Item"; }
328 const qty = stack?.quantity ?? 1;
329 if (stack?.itemId === ItemId.coins)
330 { return qty === 1 ? (def.displayName ?? "Coin") : (def.displayNamePlural ?? "Coins"); }
331 if (stack?.itemId === ItemId.potion && stack.instance?.displayName)
332 { return stack.instance.displayName; }
333 if (stack?.itemId === ItemId.dye && stack.instance?.kind === "dye")
334 { return "Dye"; }
335 if (stack?.itemId === ItemId.flower && stack.instance?.colorId)
336 {
337 return `${FLOWER_COLOR_DISPLAY[stack.instance.colorId] ?? "Flower"} flower`;
338 }
339 if (stack?.itemId === ItemId.recipePaper && stack.instance?.displayName)
340 { return stack.instance.displayName; }
341 return def.displayName ?? "Item";
342}
343
344export function stackDisplayLabel (stack)
345{
346 const name = itemDisplayName(stack);
347 const qty = stack?.quantity ?? 1;
348 if (qty <= 1)
349 { return name; }
350 return `${name} (${formatQuantity(qty)})`;
351}
352
353export function coinSpriteTierForQuantity (quantity)
354{
355 const qty = Math.max(0, Math.floor(Number(quantity) || 0));
356 let tier = COIN_SPRITE_TIERS[0];
357 for (const candidate of COIN_SPRITE_TIERS)
358 {
359 if (qty >= candidate)
360 { tier = candidate; }
361 else
362 { break; }
363 }
364 return tier;
365}
366
367/** Stack-aware description (letters include open state and author). */
368export function itemDescription (stack, { localCharacterId } = {})
369{
370 const def = itemDefinition(stack?.itemId);
371 if (!def)
372 { return ""; }
373 if (stack.itemId === ItemId.letter && stack.instance?.kind === "letter")
374 {
375 const state = stack.instance.opened === false ? "unopened" : "opened";
376 const authorId = stack.instance.authorCharacterId;
377 const byYou = authorId != null && Number(authorId) === Number(localCharacterId);
378 const author = byYou
379 ? "you"
380 : (stack.instance.authorDisplayName?.trim() || "someone");
381 return `An ${state} letter, written by ${author}.`;
382 }
383 if (stack.itemId === ItemId.filledCheque && stack.instance?.kind === "filled-cheque")
384 {
385 const reserved = itemDefinition(stack.instance.itemId);
386 const qty = stack.instance.quantity | 0;
387 const name = reserved?.displayName ?? "goods";
388 return `Bearer cheque for ${qty}× ${name}.`;
389 }
390 if (stack.itemId === ItemId.potion && stack.instance?.kind === "potion")
391 {
392 const name = stack.instance.displayName ?? "Potion";
393 return stack.instance.unstable
394 ? `${name}. An unstable brew — effects are unpredictable.`
395 : `${name}. Drink to apply its effect.`;
396 }
397 if (stack.itemId === ItemId.recipePaper && stack.instance?.kind === "recipe-paper")
398 { return "An alchemy recipe."; }
399 return def.description ?? "";
400}
401
402export function itemOriginSummary (stack)
403{
404 return formatOriginBreakdown(stack);
405}
406
407export function itemDefaultState (def)
408{
409 return def?.defaultState ?? def?.key ?? "paper";
410}
411
412export function itemSpriteName (itemId, instance = null)
413{
414 const def = itemDefinition(itemId);
415 if (!def)
416 { return spriteImageName("item", "paper", "paper"); }
417 if (itemId === ItemId.letter)
418 { return spriteImageName("item", "letter", letterVisualState(instance)); }
419 const folderKey = def.iconKey ?? def.key;
420 return def.sprite ?? spriteImageName("item", folderKey, itemDefaultState(def));
421}
422
423export function itemEquipSprite (itemId)
424{
425 const def = itemDefinition(itemId);
426 const equipment = def?.equipment;
427 if (!equipment)
428 { return null; }
429 const folderKey = def.iconKey ?? def.key;
430 return equipment.equipSprite
431 ?? equipment.overlaySpriteId
432 ?? equipImageName("item", folderKey, itemDefaultState(def));
433}
434
435/** Largest equipped light radius (e.g. lantern in offhand). */
436export function equippedLightRadiusTiles (equipment)
437{
438 let best = 0;
439 for (const stack of Object.values(equipment?.slots ?? {}))
440 {
441 if (!stack)
442 { continue; }
443 const radius = itemDefinition(stack.itemId)?.equipment?.lightRadiusTiles ?? 0;
444 if (radius > best)
445 { best = radius; }
446 }
447 return best;
448}
449
450export function letterVisualState (instance)
451{
452 return instance?.opened === false ? "letter-closed" : "letter-opened";
453}
454
455export function itemAssetPath (itemId, companion = null, instance = null)
456{
457 const def = itemDefinition(itemId);
458 const key = def?.iconKey ?? def?.key ?? "paper";
459 const state = itemId === ItemId.letter
460 ? letterVisualState(instance)
461 : itemDefaultState(def ?? { key });
462 const suffix = companion ? `-${companion}` : "";
463 return `/assets/items/${key}/${state}${suffix}.png`;
464}
465
466export function itemAssetPathForStack (stack)
467{
468 if (!stack)
469 { return itemAssetPath(null); }
470 if (stack.itemId === ItemId.coins)
471 {
472 const tier = coinSpriteTierForQuantity(stack.quantity);
473 return `/assets/items/coins/coins-${tier}.png`;
474 }
475 if (stack.itemId === ItemId.potion)
476 {
477 const fill = Math.max(1, Math.min(5, stack.instance?.fillLevel | 0 || 4));
478 return `/assets/items/potion/potion-${fill}.png`;
479 }
480 if (stack.itemId === ItemId.dye)
481 {
482 const fill = Math.max(1, Math.min(5, stack.instance?.fillLevel | 0 || 4));
483 return `/assets/items/potion/potion-${fill}.png`;
484 }
485 if (stack.itemId === ItemId.glassBottle)
486 { return `/assets/items/potion/potion-0.png`; }
487 if (stack.itemId === ItemId.flower)
488 { return `/assets/items/flower/flower.png`; }
489 return itemAssetPath(stack.itemId, null, stack.instance);
490}
491
492export const LETTER_MAX_BODY_CHARS = 2000;
493
494export const STARTER_ITEMS = Object.freeze([
495 Object.freeze({ itemId: ItemId.paper, quantity: 5 }),
496 Object.freeze({ itemId: ItemId.apple, quantity: 3 }),
497 Object.freeze({ itemId: ItemId.stick, quantity: 1 }),
498 Object.freeze({ itemId: ItemId.clothShirt, quantity: 1 }),
499 Object.freeze({ itemId: ItemId.coins, quantity: 25 })
500]);