BlueGit

timfa questward

Files

questward / shared / definitions / items.js

items.js

items.js 5.1 KiB Download Raw
1import { equipImageName, spriteImageName } from "./tileSprites.js";
2import { SkillId } from "./skills.js";
3
4export const ItemId = Object.freeze({
5 paper: 1,
6 apple: 2,
7 stick: 3,
8 blankCheque: 4,
9 clothShirt: 5,
10 letter: 6
11});
12
13export const EQUIPMENT_SLOT = Object.freeze({
14 head: "head",
15 chest: "chest",
16 legs: "legs",
17 boots: "boots",
18 weapon: "weapon",
19 offhand: "offhand"
20});
21
22export const EQUIPMENT_DRAW_ORDER = Object.freeze([
23 EQUIPMENT_SLOT.boots,
24 EQUIPMENT_SLOT.legs,
25 EQUIPMENT_SLOT.chest,
26 EQUIPMENT_SLOT.head,
27 EQUIPMENT_SLOT.offhand,
28 EQUIPMENT_SLOT.weapon
29]);
30
31export const DEFAULT_MAX_STACK = 99;
32
33export const ITEM_DEFINITIONS = Object.freeze({
34 [ItemId.paper]: Object.freeze({
35 itemId: ItemId.paper,
36 key: "paper",
37 displayName: "Paper",
38 description: "Blank paper. Right-click to write a letter.",
39 seedValue: 2,
40 stackable: true,
41 maxStackSize: DEFAULT_MAX_STACK,
42 uniqueInstance: false,
43 category: "document"
44 }),
45 [ItemId.letter]: Object.freeze({
46 itemId: ItemId.letter,
47 key: "letter",
48 displayName: "Letter",
49 description: "A written letter.",
50 seedValue: 2,
51 stackable: false,
52 maxStackSize: 1,
53 uniqueInstance: true,
54 category: "document",
55 defaultState: "letter-opened"
56 }),
57 [ItemId.apple]: Object.freeze({
58 itemId: ItemId.apple,
59 key: "apple",
60 displayName: "Apple",
61 description: "A placeholder fruit.",
62 seedValue: 1,
63 stackable: true,
64 maxStackSize: DEFAULT_MAX_STACK,
65 uniqueInstance: false,
66 category: "other"
67 }),
68 [ItemId.stick]: Object.freeze({
69 itemId: ItemId.stick,
70 key: "stick",
71 displayName: "Stick",
72 description: "A wooden stick. Can be wielded.",
73 seedValue: 3,
74 stackable: true,
75 maxStackSize: DEFAULT_MAX_STACK,
76 uniqueInstance: false,
77 category: "finished",
78 equipment: Object.freeze({
79 slot: EQUIPMENT_SLOT.weapon,
80 attack: Object.freeze({
81 mode: "melee",
82 rangeTiles: 1,
83 hitSkillId: SkillId.clubfighting,
84 damageSkillId: SkillId.strength,
85 cooldownMs: 700,
86 baseDamage: 2
87 })
88 })
89 }),
90 [ItemId.blankCheque]: Object.freeze({
91 itemId: ItemId.blankCheque,
92 key: "blank-cheque",
93 displayName: "Blank cheque",
94 description: "Placeholder bank paper. Filling comes with the bank.",
95 seedValue: 5,
96 stackable: true,
97 maxStackSize: DEFAULT_MAX_STACK,
98 uniqueInstance: false,
99 category: "document"
100 }),
101 [ItemId.clothShirt]: Object.freeze({
102 itemId: ItemId.clothShirt,
103 key: "cloth-shirt",
104 displayName: "Cloth shirt",
105 description: "A placeholder shirt worn on the chest.",
106 seedValue: 8,
107 stackable: false,
108 maxStackSize: 1,
109 uniqueInstance: false,
110 category: "finished",
111 equipment: Object.freeze({
112 slot: EQUIPMENT_SLOT.chest
113 })
114 })
115});
116
117export function itemDefinition (itemId)
118{
119 return ITEM_DEFINITIONS[itemId] ?? null;
120}
121
122/** Stack-aware description (letters include open state and author). */
123export function itemDescription (stack, { localCharacterId } = {})
124{
125 const def = itemDefinition(stack?.itemId);
126 if (!def)
127 { return ""; }
128 if (stack.itemId === ItemId.letter && stack.instance?.kind === "letter")
129 {
130 const state = stack.instance.opened === false ? "unopened" : "opened";
131 const authorId = stack.instance.authorCharacterId;
132 const byYou = authorId != null && Number(authorId) === Number(localCharacterId);
133 const author = byYou
134 ? "you"
135 : (stack.instance.authorDisplayName?.trim() || "someone");
136 return `An ${state} letter, written by ${author}.`;
137 }
138 return def.description ?? "";
139}
140
141export function itemDefaultState (def)
142{
143 return def?.defaultState ?? def?.key ?? "paper";
144}
145
146export function itemSpriteName (itemId, instance = null)
147{
148 const def = itemDefinition(itemId);
149 if (!def)
150 { return spriteImageName("item", "paper", "paper"); }
151 if (itemId === ItemId.letter)
152 { return spriteImageName("item", "letter", letterVisualState(instance)); }
153 return def.sprite ?? spriteImageName("item", def.key, itemDefaultState(def));
154}
155
156export function itemEquipSprite (itemId)
157{
158 const def = itemDefinition(itemId);
159 const equipment = def?.equipment;
160 if (!equipment)
161 { return null; }
162 return equipment.equipSprite
163 ?? equipment.overlaySpriteId
164 ?? equipImageName("item", def.key, itemDefaultState(def));
165}
166
167export function letterVisualState (instance)
168{
169 return instance?.opened === false ? "letter-closed" : "letter-opened";
170}
171
172export function itemAssetPath (itemId, companion = null, instance = null)
173{
174 const def = itemDefinition(itemId);
175 const key = def?.iconKey ?? def?.key ?? "paper";
176 const state = itemId === ItemId.letter
177 ? letterVisualState(instance)
178 : itemDefaultState(def ?? { key });
179 const suffix = companion ? `-${companion}` : "";
180 return `/assets/items/${key}/${state}${suffix}.png`;
181}
182
183export function itemAssetPathForStack (stack)
184{
185 if (!stack)
186 { return itemAssetPath(null); }
187 return itemAssetPath(stack.itemId, null, stack.instance);
188}
189
190export const LETTER_MAX_BODY_CHARS = 2000;
191
192export const STARTER_CURRENCY = 25;
193export const STARTER_ITEMS = Object.freeze([
194 Object.freeze({ itemId: ItemId.paper, quantity: 5 }),
195 Object.freeze({ itemId: ItemId.apple, quantity: 3 }),
196 Object.freeze({ itemId: ItemId.stick, quantity: 1 }),
197 Object.freeze({ itemId: ItemId.clothShirt, quantity: 1 })
198]);