zenno/doc/frbm: update with charts &c.

zenno/src/lib/data/skill.ts

@@ -0,0 +1,173 @@
+import skillGlobal from '../../../../global/skill.json'
+import groupGlobal from '../../../../global/skill-group.json'
+
+/**
+ * Skill data.
+ */
+export interface Skill {
+	/**
+	 * Skill ID.
+	 */
+	skill_id: number;
+	/**
+	 * Regional skill name.
+	 */
+	name: string;
+	/**
+	 * Regional skil description.
+	 */
+	description: string;
+	/**
+	 * Skill group ID.
+	 */
+	group: number;
+	/**
+	 * Skill rarity. 3-5 are uniques for various star levels.
+	 */
+	rarity: 1 | 2 | 3 | 4 | 5;
+	/**
+	 * Upgrade position within the skill's group.
+	 * -1 is for negative (purple) skills.
+	 */
+	group_rate: 1 | 2 | 3 | -1;
+	/**
+	 * Grade value, or the amount of rating gained for having the skill with
+	 * appropriate aptitude.
+	 */
+	grade_value?: number;
+	/**
+	 * Whether the skill requires a wit check.
+	 */
+	wit_check: boolean;
+	/**
+	 * Conditions and results of skill activation.
+	 */
+	activations: Activation[];
+	/**
+	 * Name of the Uma which owns this skill as a unique, if applicable.
+	 */
+	unique_owner?: string;
+	/**
+	 * SP cost to purchase the skill, if applicable.
+	 */
+	sp_cost?: number;
+	/**
+	 * Skill icon ID.
+	 */
+	icon_id: number;
+}
+
+/**
+ * Conditions and results of skill activation.
+ */
+export interface Activation {
+	/**
+	 * Precondition which must be satisfied before the condition is checked.
+	 */
+	precondition?: string;
+	/**
+	 * Activation conditions.
+	 */
+	condition: string;
+	/**
+	 * Skill duration in ten thousandths of a second.
+	 * Generally undefined for activations which only affect HP.
+	 */
+	duration?: number;
+	/**
+	 * Special skill duration scaling mode.
+	 */
+	dur_scale: 1 | 2 | 3 | 4 | 5 | 7;
+	/**
+	 * Skill cooldown in ten thousandths of a second.
+	 * A value of 5000000 indicates that the cooldown is forever.
+	 * Generally undefined for passive skills.
+	 */
+	cooldown?: number;
+	/**
+	 * Results applied when the skill's conditions are met.
+	 */
+	abilities: Ability[];
+}
+
+/**
+ * Effects applied when a skill activates.
+ */
+export interface Ability {
+	/**
+	 * Race mechanic affected by the ability.
+	 */
+	type: 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | 13 | 21 | 27 | 28 | 31 | 35;
+	/**
+	 * Special scaling type of the skill value.
+	 */
+	value_usage: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 13 | 14 | 19 | 20 | 22 | 23 | 24 | 25;
+	/**
+	 * Amount that the skill modifies the race mechanic in ten thousandths of
+	 * whatever is the appropriate unit.
+	 */
+	value: number;
+	/**
+	 * Selector for horses targeted by the ability.
+	 */
+	target: 1 | 2 | 4 | 7 | 9 | 10 | 11 | 18 | 19 | 20 | 21 | 22 | 23;
+	/**
+	 * Argument value for the ability target, when appropriate.
+	 */
+	target_value?: number;
+}
+
+/**
+ * Skill groups.
+ * Skills in a skill group replace each other when purchased.
+ * 
+ * As a special case, horsegen lists both unique skills and their inherited
+ * versions in the skill groups for both.
+ */
+export interface SkillGroup {
+	/**
+	 * Skill group ID.
+	 */
+	skill_group: number;
+	/**
+	 * Base skill in the skill group, if any.
+	 * Either a common (white) skill or an Uma's own unique.
+	 * 
+	 * Some skill groups, e.g. for G1 Averseness, have no base skill.
+	 */
+	skill1?: number;
+	/**
+	 * First upgraded version of a skill, if any.
+	 * A rare (gold) skill, double circle skill, or an inherited unique skill.
+	 */
+	skill2?: number;
+	/**
+	 * Highest upgraded version of a skill, if any.
+	 * Gold version of a skill with a double circle version.
+	 */
+	skill3?: number;
+	/**
+	 * Negative (purple) version of a skill, if any.
+	 */
+	skill_bad?: number;
+}
+
+export const skills = {
+    global: skillGlobal as Skill[],
+} as const;
+
+export const skillGroups = {
+	global: groupGlobal as SkillGroup[],
+} as const;
+
+export const ZERO_SKILL: Readonly<Skill> = {
+	skill_id: 0,
+	name: "invalid skill",
+	description: "an invalid skill was specified",
+	group: 0,
+	rarity: 1,
+	group_rate: 1,
+	wit_check: false,
+	activations: [],
+	icon_id: 0,
+} as const;