zenno/doc/spark: spark explorer

2026-07-07 15:51:28 -04:00
parent 5cbb6d7b1d
commit 0c518a9ce2
2 changed files with 171 additions and 6 deletions
@@ -28,22 +28,116 @@ export interface Spark {
 	 * Spark type.
 	 * Roughly the spark color, with extra subdivisions for white sparks.
 	 */
-	type: 1 | 2 | 5 | 4 | 6 | 7 | 10 | 8 | 11 | 9 | 3;
+	type: Type;
 	/**
 	 * Possible effects applied by the spark during inspiration.
 	 * A random element is selected from this list according to unknown
 	 * distributions, then all effects in that selection are applied.
 	 */
-	effects: SparkEffect[][];
+	effects: Effect[][];
+}
+
+/**
+ * Spark types.
+ * Roughly the spark color, with extra subdivisions for white sparks.
+ */
+export enum Type {
+	Stat = 1,
+	Aptitude = 2,
+	Unique = 3,
+	Skill = 4,
+	Race = 5,
+	Scenario = 6,
+	CarnivalBonus = 7,
+	Distance = 8,
+	Hidden = 9,
+	Surface = 10,
+	Style = 11,
+}
+
+/** Mapping of spark types to their names. */
+export const TYPE_NAMES: Readonly<Record<Type, string>> = {
+	[Type.Stat]: 'Stat (Blue)',
+	[Type.Aptitude]: 'Aptitude (Pink)',
+	[Type.Unique]: 'Unique (Green)',
+	[Type.Skill]: 'Skill',
+	[Type.Race]: 'Race',
+	[Type.Scenario]: 'Scenario',
+	[Type.CarnivalBonus]: 'Carnival Bonus (Scarlet)',
+	[Type.Distance]: 'Distance (White)',
+	[Type.Hidden]: 'Hidden (White)',
+	[Type.Surface] : 'Surface (White)',
+	[Type.Style] : 'Style (White)',
+};
+
+/**
+ * Spark effect types.
+ */
+export enum Target {
+	Speed = 1,
+	Stamina = 2,
+	Power = 3,
+	Guts = 4,
+	Wit = 5,
+	SkillPoints = 6,
+	RandomStat = 7,
+	Turf = 11,
+	Dirt = 12,
+	FrontRunner = 21,
+	PaceChaser = 22,
+	LateSurger = 23,
+	EndCloser = 24,
+	Sprint = 31,
+	Mile = 32,
+	Medium = 33,
+	Long = 34,
+	Skill = 41,
+	CarnivalBonus = 51,
+	SpeedCap = 61,
+	StaminaCap = 62,
+	PowerCap = 63,
+	GutsCap = 64,
+	WitCap = 65,
+}
+
+/**
+ * Mapping of spark target types to their names.
+ * Note that Skill does not include the skill name.
+ */
+export const TARGET_NAMES: Readonly<Record<Target, string>> = {
+	[Target.Speed]: 'Speed',
+	[Target.Stamina]: 'Stamina',
+	[Target.Power]: 'Power',
+	[Target.Guts]: 'Guts',
+	[Target.Wit]: 'Wit',
+	[Target.SkillPoints]: 'SP',
+	[Target.RandomStat]: 'Random Stat',
+	[Target.Turf]: 'Turf aptitude',
+	[Target.Dirt]: 'Dirt aptitude',
+	[Target.FrontRunner]: 'Front Runner aptitude',
+	[Target.PaceChaser]: 'Pace Chaser aptitude',
+	[Target.LateSurger]: 'Late Surger aptitude',
+	[Target.EndCloser]: 'End Closer aptitude',
+	[Target.Sprint]: 'Sprint aptitude',
+	[Target.Mile]: 'Mile aptitude',
+	[Target.Medium]: 'Medium aptitude',
+	[Target.Long]: 'Long aptitude',
+	[Target.Skill]: 'hint level',
+	[Target.CarnivalBonus]: 'Carnival Bonus level',
+	[Target.SpeedCap]: 'Speed cap',
+	[Target.StaminaCap]: 'Stamina cap',
+	[Target.PowerCap]: 'Power cap',
+	[Target.GutsCap]: 'Guts cap',
+	[Target.WitCap]: 'Wit cap',
 }

 /**
 * Effects that a spark can apply.
 */
-export interface SparkEffect {
-	target: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 11 | 12 | 21 | 22 | 23 | 24 | 31 | 32 | 33 | 34 | 41 | 51 | 61 | 62 | 63 | 64 | 65;
-	value1?: number;
-	value2: number;
+export interface Effect {
+	target: Target;
+	value1: number;
+	value2?: number;
 }

 export async function sparks(): Promise<Spark[]> {