BlueGit

timfa questward

Files

questward / shared / definitions / materialTiers.js

materialTiers.js

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