BlueGit

timfa questward

Files

questward / shared / definitions / materialTiers.js

materialTiers.js

materialTiers.js 12.0 KiB Download Raw
1/**
2 * Metal materials (and coal) — name, tint, rank, and skill gates.
3 * Equip min level is the tier gate; mining = half (ceil), smelting = 75% (ceil).
4 */
5export const MaterialTier = Object.freeze({
6 bronze: "bronze",
7 iron: "iron",
8 steel: "steel",
9 mithril: "mithril",
10 adamantium: "adamantium",
11 orichalcum: "orichalcum",
12 dragon: "dragon"
13});
14
15/**
16 * Wood materials — same ranks / skill gates as metals (gather with axe later).
17 * Matching metal: pine↔bronze … elder↔dragon.
18 */
19export const WoodTier = Object.freeze({
20 pine: "pine",
21 birch: "birch",
22 oak: "oak",
23 ebony: "ebony",
24 lignum: "lignum",
25 heartwood: "heartwood",
26 elder: "elder"
27});
28
29/** Ordered low → high (metal smithing / tools). */
30export const MATERIAL_TIER_ORDER = Object.freeze([
31 MaterialTier.bronze,
32 MaterialTier.iron,
33 MaterialTier.steel,
34 MaterialTier.mithril,
35 MaterialTier.adamantium,
36 MaterialTier.orichalcum,
37 MaterialTier.dragon
38]);
39
40/** Ordered low → high (woodcutting / woodcraft). */
41export const WOOD_TIER_ORDER = Object.freeze([
42 WoodTier.pine,
43 WoodTier.birch,
44 WoodTier.oak,
45 WoodTier.ebony,
46 WoodTier.lignum,
47 WoodTier.heartwood,
48 WoodTier.elder
49]);
50
51/**
52 * Gatherable ores / fuels that are not always 1:1 with a gear tier.
53 * Tin + copper smelt into bronze; coal fuels steel. Gold and silver have ore +
54 * bars but no tools (jewelry / future recipes). Mine/smelt timing uses
55 * {@link associatedBarTier}.
56 */
57export const GatherMaterialId = Object.freeze({
58 ...MaterialTier,
59 tin: "tin",
60 copper: "copper",
61 coal: "coal",
62 silver: "silver",
63 gold: "gold"
64});
65
66/** Minimum relevant skill level required to equip tools/gear of this tier. */
67export const TIER_MIN_SKILL_LEVEL = Object.freeze({
68 [MaterialTier.bronze]: 1,
69 [MaterialTier.iron]: 10,
70 [MaterialTier.steel]: 20,
71 [MaterialTier.mithril]: 35,
72 [MaterialTier.adamantium]: 50,
73 [MaterialTier.orichalcum]: 70,
74 [MaterialTier.dragon]: 90,
75 [GatherMaterialId.silver]: 10,
76 [GatherMaterialId.gold]: 20,
77 [WoodTier.pine]: 1,
78 [WoodTier.birch]: 10,
79 [WoodTier.oak]: 20,
80 [WoodTier.ebony]: 35,
81 [WoodTier.lignum]: 50,
82 [WoodTier.heartwood]: 70,
83 [WoodTier.elder]: 90
84});
85
86/** Rank used for mining duration and relative power (1 = bronze/pine … 7 = dragon/elder). */
87export const TIER_RANK = Object.freeze({
88 [MaterialTier.bronze]: 1,
89 [MaterialTier.iron]: 2,
90 [MaterialTier.steel]: 3,
91 [MaterialTier.mithril]: 4,
92 [MaterialTier.adamantium]: 5,
93 [MaterialTier.orichalcum]: 6,
94 [MaterialTier.dragon]: 7,
95 [GatherMaterialId.silver]: 2,
96 [GatherMaterialId.gold]: 3,
97 [WoodTier.pine]: 1,
98 [WoodTier.birch]: 2,
99 [WoodTier.oak]: 3,
100 [WoodTier.ebony]: 4,
101 [WoodTier.lignum]: 5,
102 [WoodTier.heartwood]: 6,
103 [WoodTier.elder]: 7
104});
105
106/** Stat bonus granted by tier for the equipment's bonus category. */
107export const TIER_STAT_BONUS = Object.freeze({
108 [MaterialTier.bronze]: 1,
109 [MaterialTier.iron]: 2,
110 [MaterialTier.steel]: 4,
111 [MaterialTier.mithril]: 6,
112 [MaterialTier.adamantium]: 8,
113 [MaterialTier.orichalcum]: 10,
114 [MaterialTier.dragon]: 12,
115 [WoodTier.pine]: 1,
116 [WoodTier.birch]: 2,
117 [WoodTier.oak]: 4,
118 [WoodTier.ebony]: 6,
119 [WoodTier.lignum]: 8,
120 [WoodTier.heartwood]: 10,
121 [WoodTier.elder]: 12
122});
123
124/** Display names for UI / editor. */
125export const MATERIAL_DISPLAY_NAME = Object.freeze({
126 [MaterialTier.bronze]: "Bronze",
127 [MaterialTier.iron]: "Iron",
128 [MaterialTier.steel]: "Steel",
129 [MaterialTier.mithril]: "Mithril",
130 [MaterialTier.adamantium]: "Adamantium",
131 [MaterialTier.orichalcum]: "Orichalcum",
132 [MaterialTier.dragon]: "Dragon",
133 [GatherMaterialId.tin]: "Tin",
134 [GatherMaterialId.copper]: "Copper",
135 [GatherMaterialId.coal]: "Coal",
136 [GatherMaterialId.silver]: "Silver",
137 [GatherMaterialId.gold]: "Gold",
138 [WoodTier.pine]: "Pine",
139 [WoodTier.birch]: "Birch",
140 [WoodTier.oak]: "Oak",
141 [WoodTier.ebony]: "Ebony",
142 [WoodTier.lignum]: "Lignum",
143 [WoodTier.heartwood]: "Heartwood",
144 [WoodTier.elder]: "Elder"
145});
146
147/**
148 * Author tint swatches via {@link rgb} (0–255) so editors can offer a colour picker.
149 * Also accepts `0xRRGGBB` / `"#RRGGBB"`; all forms become 0–1 RGB at module load.
150 * Steel is slightly darker than iron; silver is bright gray; gold is yellow;
151 * orichalcum is coppery; dragon is red.
152 */
153export function rgb (r, g, b)
154{
155 return Object.freeze({
156 r: clampByte(r) / 255,
157 g: clampByte(g) / 255,
158 b: clampByte(b) / 255
159 });
160}
161
162function clampByte (n)
163{
164 return Math.min(255, Math.max(0, Math.round(Number(n) || 0)));
165}
166
167export const MATERIAL_TINT_HEX = Object.freeze({
168 [MaterialTier.bronze]: rgb(184, 122, 71),
169 [MaterialTier.iron]: rgb(158, 163, 173),
170 [MaterialTier.steel]: rgb(75, 76, 80),
171 [MaterialTier.mithril]: rgb(3, 120, 255),
172 [MaterialTier.adamantium]: rgb(108, 202, 132),
173 [MaterialTier.orichalcum]: rgb(230, 140, 31),
174 [MaterialTier.dragon]: rgb(228, 19, 15),
175 [GatherMaterialId.tin]: rgb(221, 221, 221),
176 [GatherMaterialId.copper]: rgb(255, 94, 0),
177 [GatherMaterialId.coal]: rgb(45, 45, 48),
178 [GatherMaterialId.silver]: rgb(214, 220, 230),
179 [GatherMaterialId.gold]: rgb(255, 200, 0),
180 [WoodTier.pine]: rgb(199, 158, 97),
181 [WoodTier.birch]: rgb(224, 209, 173),
182 [WoodTier.oak]: rgb(158, 107, 61),
183 [WoodTier.ebony]: rgb(56, 41, 51),
184 [WoodTier.lignum]: rgb(107, 97, 56),
185 [WoodTier.heartwood]: rgb(184, 71, 56),
186 [WoodTier.elder]: rgb(184, 189, 199)
187});
188
189/**
190 * Optional ore-only tint overrides (boulders + ore items).
191 * Missing entries fall back to {@link MATERIAL_TINT_HEX}.
192 */
193export const MATERIAL_ORE_TINT_HEX = Object.freeze({
194 [MaterialTier.iron]: rgb(210, 118, 48),
195 [GatherMaterialId.copper]: rgb(81, 153, 105)
196});
197
198/**
199 * Normalize tint authoring forms to frozen 0–1 `{ r, g, b }`:
200 * - number `0xRRGGBB`
201 * - string `"#RGB"` / `"#RRGGBB"` / `"rgb(r,g,b)"`
202 * - object from {@link rgb}
203 */
204export function hexToRgb01 (hex)
205{
206 if (hex && typeof hex === "object" && "r" in hex && "g" in hex && "b" in hex)
207 {
208 return Object.freeze({
209 r: clamp01Channel(hex.r),
210 g: clamp01Channel(hex.g),
211 b: clamp01Channel(hex.b)
212 });
213 }
214 if (typeof hex === "number" && Number.isFinite(hex))
215 {
216 const value = hex >>> 0;
217 return Object.freeze({
218 r: ((value >> 16) & 255) / 255,
219 g: ((value >> 8) & 255) / 255,
220 b: (value & 255) / 255
221 });
222 }
223 const text = String(hex ?? "").trim();
224 const rgbMatch = /^rgba?\(\s*([0-9.]+)\s*,\s*([0-9.]+)\s*,\s*([0-9.]+)/i.exec(text);
225 if (rgbMatch)
226 { return rgb(rgbMatch[1], rgbMatch[2], rgbMatch[3]); }
227 const raw = text.replace(/^#/, "");
228 const full = raw.length === 3
229 ? raw.split("").map((ch) => ch + ch).join("")
230 : raw;
231 if (!/^[0-9a-fA-F]{6}$/.test(full))
232 { return Object.freeze({ r: 0.7, g: 0.7, b: 0.7 }); }
233 const value = Number.parseInt(full, 16);
234 return Object.freeze({
235 r: ((value >> 16) & 255) / 255,
236 g: ((value >> 8) & 255) / 255,
237 b: (value & 255) / 255
238 });
239}
240
241function clamp01Channel (n)
242{
243 const value = Number(n);
244 if (!Number.isFinite(value))
245 { return 0; }
246 if (value > 1)
247 { return clampByte(value) / 255; }
248 return Math.min(1, Math.max(0, value));
249}
250
251/** 0–1 RGB map derived from {@link MATERIAL_TINT_HEX}. */
252export const MATERIAL_TINT_COLOR = Object.freeze(
253 Object.fromEntries(
254 Object.entries(MATERIAL_TINT_HEX).map(([id, hex]) => [id, hexToRgb01(hex)])
255 )
256);
257
258/** 0–1 RGB map derived from {@link MATERIAL_ORE_TINT_HEX}. */
259export const MATERIAL_ORE_TINT_COLOR = Object.freeze(
260 Object.fromEntries(
261 Object.entries(MATERIAL_ORE_TINT_HEX).map(([id, hex]) => [id, hexToRgb01(hex)])
262 )
263);
264
265/** Wood tier that matches a metal tier's rank (for tool hafts). */
266export const WOOD_TIER_FOR_METAL = Object.freeze({
267 [MaterialTier.bronze]: WoodTier.pine,
268 [MaterialTier.iron]: WoodTier.birch,
269 [MaterialTier.steel]: WoodTier.oak,
270 [MaterialTier.mithril]: WoodTier.ebony,
271 [MaterialTier.adamantium]: WoodTier.lignum,
272 [MaterialTier.orichalcum]: WoodTier.heartwood,
273 [MaterialTier.dragon]: WoodTier.elder
274});
275
276export const METAL_TIER_FOR_WOOD = Object.freeze(Object.fromEntries(
277 Object.entries(WOOD_TIER_FOR_METAL).map(([metal, wood]) => [wood, metal])
278));
279
280/**
281 * Bar tier that drives mine/smelt duration and gates for a gatherable.
282 * Tin/copper → bronze; coal → steel; gold/silver and gear metals map to themselves.
283 */
284export function associatedBarTier (materialId)
285{
286 if (materialId === GatherMaterialId.tin || materialId === GatherMaterialId.copper)
287 { return MaterialTier.bronze; }
288 if (materialId === GatherMaterialId.coal)
289 { return MaterialTier.steel; }
290 return materialId;
291}
292
293export function materialDisplayName (materialId)
294{
295 return MATERIAL_DISPLAY_NAME[materialId] ?? materialId;
296}
297
298/**
299 * Tint for a material. When `ore` is true, prefer {@link MATERIAL_ORE_TINT_COLOR}
300 * if defined for that material; otherwise the normal material tint.
301 */
302export function materialTintColor (materialId, { ore = false } = {})
303{
304 if (ore)
305 {
306 const oreTint = MATERIAL_ORE_TINT_COLOR[materialId];
307 if (oreTint)
308 { return oreTint; }
309 }
310 return MATERIAL_TINT_COLOR[materialId] ?? MATERIAL_TINT_COLOR[MaterialTier.bronze];
311}
312
313export function tierStatBonus (tier)
314{
315 return TIER_STAT_BONUS[tier] ?? TIER_STAT_BONUS[MaterialTier.bronze];
316}
317
318export function tierMinSkillLevel (tier)
319{
320 return TIER_MIN_SKILL_LEVEL[tier] ?? TIER_MIN_SKILL_LEVEL[MaterialTier.bronze];
321}
322
323export function tierRank (tier)
324{
325 return TIER_RANK[associatedBarTier(tier)] ?? TIER_RANK[tier] ?? 1;
326}
327
328/** Mining / woodcutting skill required (half of equip gate, ceil). */
329export function tierMineSkillLevel (tier)
330{
331 return Math.max(1, Math.ceil(tierMinSkillLevel(associatedBarTier(tier)) / 2));
332}
333
334/** Smithing / woodcraft skill required to process this material (75% of equip gate, ceil). */
335export function tierSmeltSkillLevel (tier)
336{
337 return Math.max(1, Math.ceil(tierMinSkillLevel(associatedBarTier(tier)) * 0.75));
338}
339
340/** Alias for woodworking / general craft gates (same curve as smelting). */
341export function tierCraftSkillLevel (tier)
342{
343 return tierSmeltSkillLevel(tier);
344}
345
346export function woodTierForMetal (metalTier)
347{
348 return WOOD_TIER_FOR_METAL[metalTier] ?? WoodTier.pine;
349}
350
351export function metalTierForWood (woodTier)
352{
353 return METAL_TIER_FOR_WOOD[woodTier] ?? MaterialTier.bronze;
354}
355
356/**
357 * Mining action duration in ms.
358 * (resourceRank * 8s) − (toolRank * 3s), floored at 0.5s.
359 * Tin/copper/coal use their associated bar's rank.
360 */
361export function miningDurationMs (resourceMaterialId, toolTier)
362{
363 const resourceRank = tierRank(resourceMaterialId);
364 const toolRank = tierRank(toolTier);
365 const seconds = Math.max(0.5, resourceRank * 8 - toolRank * 3);
366 return Math.round(seconds * 1000);
367}
368
369/** After a successful mine, nodes stay exhausted for 10s × associated bar rank. */
370export function oreExhaustDurationMs (materialId)
371{
372 return Math.max(1, tierRank(materialId)) * 10_000;
373}
374
375/** Base craft duration per bar rank (bronze = 2s, iron = 4s, …). */
376export const SMELT_DURATION_PER_RANK_MS = 2000;
377
378/**
379 * Furnace smelt duration from the output bar's associated tier rank.
380 * Tin/copper/coal map to bronze/steel so ingredient timing matches that bar.
381 */
382export function smeltingDurationMs (barOrMaterialId)
383{
384 return Math.max(1, tierRank(barOrMaterialId)) * SMELT_DURATION_PER_RANK_MS;
385}
386
387/** Visual / interact state while an ore boulder is depleted (plain rock). */
388export const EXHAUSTED_ORE_BOULDER_STATE = "boulder";
389
390/**
391 * Materials that have an ore boulder node.
392 * Bronze has no ore (tin + copper); steel has no ore (iron + coal).
393 * Gold and silver are precious only (ore + bars, no tools).
394 */
395export const ORE_BEARING_MATERIALS = Object.freeze([
396 GatherMaterialId.tin,
397 GatherMaterialId.copper,
398 MaterialTier.iron,
399 GatherMaterialId.silver,
400 GatherMaterialId.gold,
401 MaterialTier.mithril,
402 MaterialTier.adamantium,
403 MaterialTier.orichalcum,
404 MaterialTier.dragon,
405 GatherMaterialId.coal
406]);
407
408/** Boulder visual state for a gatherable ore (editor / world). */
409export function oreBoulderState (materialId)
410{
411 if (materialId === GatherMaterialId.coal)
412 { return "coal"; }
413 return `${materialId}-ore`;
414}
415
416export function materialFromOreBoulderState (state)
417{
418 if (!state || state === "boulder")
419 { return null; }
420 if (state === "coal")
421 { return GatherMaterialId.coal; }
422 if (state.endsWith("-ore"))
423 {
424 const id = state.slice(0, -"-ore".length);
425 if (ORE_BEARING_MATERIALS.includes(id))
426 { return id; }
427 }
428 return null;
429}
430
431export function isOreBoulderState (state)
432{
433 return materialFromOreBoulderState(state) != null;
434}