BlueGit

timfa questward

Files

questward / shared / definitions / items.js

items.js

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