Add Nola (#133)

Author: apache1123

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tof-tools",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "private": true,
   "scripts": {
     "dev": "next dev",

public/icons/elements/altered.png

@@ -1,12 +1,12 @@
 import type { TypographyProps } from '@mui/material';
 import { Typography } from '@mui/material';
 
-import type { ElementalType } from '../../constants/elemental-type';
+import type { WeaponElementalType } from '../../constants/elemental-type';
 import { pascalCaseToCamelCase } from '../../utils/string-utils';
 
 export interface ElementalStyledTextProps
   extends TypographyProps<'span', { component?: 'span' }> {
-  elementalType: ElementalType;
+  elementalType: WeaponElementalType;
 }
 
 export function ElementalStyledText({

public/icons/elements/altered.webp

@@ -0,0 +1,20 @@
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { ElementalTypeIcon } from './ElementalTypeIcon';
+
+const meta: Meta<typeof ElementalTypeIcon> = {
+  title: 'Elemental Type Icon',
+  component: ElementalTypeIcon,
+  tags: ['autodocs'],
+};
+
+export default meta;
+type Story = StoryObj<typeof ElementalTypeIcon>;
+
+export const Initial: Story = {
+  args: {
+    elementalType: 'Flame-Physical',
+    width: 30,
+    height: 30,
+  },
+};

public/icons/elements/flame-physical.webp

@@ -1,10 +1,10 @@
 import Image from 'next/image';
 
-import type { ElementalType } from '../../constants/elemental-type';
-import { pascalCaseToCamelCase } from '../../utils/string-utils';
+import type { FusionWeaponElementalType } from '../../constants/elemental-type';
+import { pascalCaseToKebabCase } from '../../utils/string-utils';
 
 export interface ElementalTypeIconProps {
-  elementalType: ElementalType;
+  elementalType: FusionWeaponElementalType;
   width?: number;
   height?: number;
 }
@@ -14,8 +14,8 @@ export function ElementalTypeIcon({
   width = 24,
   height = 22,
 }: ElementalTypeIconProps) {
-  const imageName = pascalCaseToCamelCase(elementalType);
-  const imagePath = `/icons/elements/${imageName}.png`;
+  const imageName = pascalCaseToKebabCase(elementalType);
+  const imagePath = `/icons/elements/${imageName}.webp`;
 
   return (
     <Image

public/icons/elements/flame.png

@@ -0,0 +1,20 @@
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { WeaponIcon } from './WeaponIcon';
+
+const meta: Meta<typeof WeaponIcon> = {
+  title: 'Weapon Icon',
+  component: WeaponIcon,
+  tags: ['autodocs'],
+};
+
+export default meta;
+type Story = StoryObj<typeof WeaponIcon>;
+
+export const Initial: Story = {
+  args: {
+    weaponName: 'Nola',
+    size: 100,
+    elementalIcon: 'Flame-Physical',
+  },
+};

public/icons/elements/flame.webp

@@ -2,27 +2,46 @@ import QuestionMarkIcon from '@mui/icons-material/QuestionMark';
 import { Box } from '@mui/material';
 import Image from 'next/image';
 
+import type { FusionWeaponElementalType } from '../../constants/elemental-type';
 import type { WeaponName } from '../../constants/weapons/weapon-definitions';
 import { normalCaseToKebabCase } from '../../utils/string-utils';
+import { ElementalTypeIcon } from '../ElementalTypeIcon/ElementalTypeIcon';
 
 export interface WeaponIconProps {
   weaponName: WeaponName | undefined;
   size?: number;
+  /** If defined, will overlay the elemental type icon on top of the weapon icon */
+  elementalIcon?: FusionWeaponElementalType;
 }
 
-export const WeaponIcon = ({ weaponName, size = 100 }: WeaponIconProps) => {
+export const WeaponIcon = ({
+  weaponName,
+  size = 100,
+  elementalIcon,
+}: WeaponIconProps) => {
   if (weaponName) {
     const imageName = normalCaseToKebabCase(weaponName);
     const imagePath = `/icons/weapons/${imageName}.png`;
 
     return (
-      <Image
-        src={imagePath}
-        alt={weaponName}
-        title={weaponName}
-        width={size}
-        height={size}
-      ></Image>
+      <Box width={size} height={size} position={'relative'}>
+        <Image
+          src={imagePath}
+          alt={weaponName}
+          title={weaponName}
+          width={size}
+          height={size}
+        ></Image>
+        {elementalIcon && (
+          <Box position={'absolute'} right={0} bottom={0}>
+            <ElementalTypeIcon
+              elementalType={elementalIcon}
+              width={size / 4}
+              height={size / 4}
+            />
+          </Box>
+        )}
+      </Box>
     );
   }
   return (

public/icons/elements/frost-volt.webp

@@ -223,4 +223,11 @@ export const changelog: Changelog = [
     date: new Date(Date.UTC(2024, 6, 6)),
     title: 'Add Anka',
   },
+  {
+    semver: '3.17.0',
+    date: new Date(Date.UTC(2024, 7, 20)),
+    title: 'Add Nola',
+    description:
+      'Since simulacra trait selection has not been added to the gear comparer yet, the calculator assumes you might also equip her trait when using Nola. (Nola trait buffs all ATK for every altered weapon equipped)',
+  },
 ];

public/icons/elements/frost.png

@@ -2,4 +2,12 @@ export type CoreElementalType = 'Flame' | 'Frost' | 'Physical' | 'Volt';
 
 export type WeaponElementalType = CoreElementalType | 'Altered';
 
-export type ElementalType = WeaponElementalType | 'None' | 'All';
+// TODO: merge this with `WeaponElementalType` above in the future
+export type FusionWeaponElementalType =
+  | WeaponElementalType
+  | 'Flame-Physical'
+  | 'Frost-Volt'
+  | 'Physical-Flame'
+  | 'Volt-Frost';
+
+export type StatTypeElementalType = WeaponElementalType | 'None' | 'All';

public/icons/elements/frost.webp

@@ -9,7 +9,17 @@ import type { WeaponName } from './weapons/weapon-definitions';
 export const matrixSet2pcLabel = '2pc';
 export const matrixSet4pcLabel = '4pc';
 
-export type MatrixSetBaseName = WeaponName | 'Haboela' | 'Scylla';
+export type MatrixSetBaseName =
+  | Exclude<
+      WeaponName,
+      | 'Nola (Altered)'
+      | 'Nola (Flame-Physical)'
+      | 'Nola (Frost-Volt)'
+      | 'Nola (Physical-Flame)'
+      | 'Nola (Volt-Frost)'
+    >
+  | 'Haboela'
+  | 'Scylla';
 
 export const matrixSet2pcOrder: DataAllIds<MatrixSet2pcName> = [
   'Alyss 2pc',
@@ -41,6 +51,7 @@ export const matrixSet2pcOrder: DataAllIds<MatrixSet2pcName> = [
   'Ming Jing 2pc',
   'Nan Yin 2pc',
   'Nemesis 2pc',
+  'Nola 2pc',
   'Plotti 2pc',
   'Rei 2pc',
   'Roslyn 2pc',
@@ -89,6 +100,7 @@ export const matrixSet4pcOrder: DataAllIds<MatrixSet4pcName> = [
   'Ming Jing 4pc',
   'Nan Yin 4pc',
   'Nemesis 4pc',
+  'Nola 4pc',
   'Plotti 4pc',
   'Rei 4pc',
   'Roslyn 4pc',
@@ -620,6 +632,37 @@ export const matrixSetDefinitionsLookup: DataById<
     critDamageBuffs: [],
     buffs: [],
   },
+  'Nola 2pc': {
+    id: 'Nola 2pc',
+    displayName: 'Nola 2pc',
+    pieces: 2,
+    attackPercentBuffs: [
+      {
+        description:
+          "When Nola's weapon is equipped, increase all ATK, works off-hand",
+        starValues: [
+          { star: 0, value: 0.24 },
+          { star: 1, value: 0.26 },
+          { star: 2, value: 0.28 },
+          { star: 3, value: 0.3 },
+        ],
+        elementalTypes: ['Flame', 'Frost', 'Physical', 'Volt'],
+        canStack: false,
+        isActivePassively: true,
+        weaponRequirements: [
+          'Nola',
+          'Nola (Altered)',
+          'Nola (Flame-Physical)',
+          'Nola (Frost-Volt)',
+          'Nola (Physical-Flame)',
+          'Nola (Volt-Frost)',
+        ],
+      },
+    ],
+    critRateBuffs: [],
+    critDamageBuffs: [],
+    buffs: [],
+  },
   'Plotti 2pc': {
     id: 'Plotti 2pc',
     displayName: 'Plotti 2pc',
@@ -868,7 +911,7 @@ export const matrixSetDefinitionsLookup: DataById<
         ],
         canStack: false,
         isActivePassively: true,
-        weaponRequirement: 'Anka',
+        weaponRequirements: ['Anka'],
       },
     ],
     buffs: [],
@@ -1106,7 +1149,7 @@ export const matrixSetDefinitionsLookup: DataById<
         ],
         canStack: false,
         isActivePassively: true,
-        weaponRequirement: 'Ji Yu',
+        weaponRequirements: ['Ji Yu'],
       },
     ],
     buffs: [
@@ -1202,7 +1245,7 @@ export const matrixSetDefinitionsLookup: DataById<
         elementalTypes: ['Altered', 'Flame', 'Frost', 'Physical', 'Volt'],
         canStack: false,
         isActivePassively: true,
-        weaponRequirement: 'Ling Han',
+        weaponRequirements: ['Ling Han'],
       },
     ],
     critRateBuffs: [],
@@ -1277,7 +1320,7 @@ export const matrixSetDefinitionsLookup: DataById<
         ],
         canStack: false,
         isActivePassively: true,
-        weaponRequirement: 'Nan Yin',
+        weaponRequirements: ['Nan Yin'],
       },
     ],
     buffs: [],
@@ -1291,6 +1334,15 @@ export const matrixSetDefinitionsLookup: DataById<
     critDamageBuffs: [],
     buffs: [],
   },
+  'Nola 4pc': {
+    id: 'Nola 4pc',
+    displayName: 'Nola 4pc',
+    pieces: 4,
+    attackPercentBuffs: [],
+    critRateBuffs: [],
+    critDamageBuffs: [],
+    buffs: [],
+  },
   'Plotti 4pc': {
     id: 'Plotti 4pc',
     displayName: 'Plotti 4pc',
@@ -1317,7 +1369,7 @@ export const matrixSetDefinitionsLookup: DataById<
         elementalTypes: ['Volt', 'Frost'],
         canStack: false,
         isActivePassively: false,
-        weaponRequirement: 'Rei',
+        weaponRequirements: ['Rei'],
       },
     ],
     critRateBuffs: [],

public/icons/elements/physical-flame.webp

@@ -2,7 +2,14 @@ import type { Data } from '../models/data';
 import type { SimulacrumTrait } from '../models/v4/simulacrum-trait';
 import type { WeaponName } from './weapons/weapon-definitions';
 
-export type SimulacrumName = WeaponName;
+export type SimulacrumName = Exclude<
+  WeaponName,
+  | 'Nola (Altered)'
+  | 'Nola (Flame-Physical)'
+  | 'Nola (Frost-Volt)'
+  | 'Nola (Physical-Flame)'
+  | 'Nola (Volt-Frost)'
+>;
 
 export const simulacrumTraits: Data<SimulacrumName, SimulacrumTrait> = {
   allIds: [
@@ -33,6 +40,7 @@ export const simulacrumTraits: Data<SimulacrumName, SimulacrumTrait> = {
     'Ming Jing',
     'Nan Yin',
     'Nemesis',
+    'Nola',
     'Plotti',
     'Rei',
     'Roslyn',
@@ -890,6 +898,11 @@ export const simulacrumTraits: Data<SimulacrumName, SimulacrumTrait> = {
       displayName: 'Nemesis',
       buffs: [],
     },
+    Nola: {
+      id: 'Nola',
+      displayName: 'Nola',
+      buffs: [],
+    },
     Plotti: {
       id: 'Plotti',
       displayName: 'Plotti',

public/icons/elements/physical.png

@@ -3,6 +3,7 @@ import type { WeaponDefinition } from '../../../models/weapon-definition';
 export const alyss = {
   id: 'Alyss',
   displayName: 'Alyss',
+  elementalIcon: 'Frost',
   resonanceElements: ['Frost'],
   calculationElements: ['Frost'],
   damageElement: 'Frost',

public/icons/elements/physical.webp

@@ -3,6 +3,7 @@ import type { WeaponDefinition } from '../../../models/weapon-definition';
 export const anka = {
   id: 'Anka',
   displayName: 'Anka',
+  elementalIcon: 'Physical-Flame',
   resonanceElements: ['Physical', 'Flame'],
   calculationElements: ['Physical', 'Flame'],
   damageElement: 'Physical',

public/icons/elements/volt-frost.webp

@@ -3,6 +3,7 @@ import type { WeaponDefinition } from '../../../models/weapon-definition';
 export const annabella = {
   id: 'Annabella',
   displayName: 'Annabella',
+  elementalIcon: 'Flame',
   resonanceElements: ['Flame'],
   calculationElements: ['Flame'],
   damageElement: 'Flame',

public/icons/elements/volt.png

@@ -3,6 +3,7 @@ import type { WeaponDefinition } from '../../../models/weapon-definition';
 export const asuka = {
   id: 'Asuka',
   displayName: 'Asuka',
+  elementalIcon: 'Physical-Flame',
   resonanceElements: ['Physical', 'Flame'],
   calculationElements: ['Physical', 'Flame'],
   damageElement: 'Physical',

public/icons/elements/volt.webp

@@ -10,6 +10,7 @@ import { minEventDuration } from '../../tick';
 export const brevey = {
   id: 'Brevey',
   displayName: 'Brevey',
+  elementalIcon: 'Volt-Frost',
   resonanceElements: ['Volt', 'Frost'],
   calculationElements: ['Volt', 'Frost'],
   damageElement: 'Volt',

public/icons/matrices/nola.webp

@@ -3,6 +3,7 @@ import type { WeaponDefinition } from '../../../models/weapon-definition';
 export const claudia = {
   id: 'Claudia',
   displayName: 'Claudia',
+  elementalIcon: 'Physical',
   resonanceElements: ['Physical'],
   calculationElements: ['Physical'],
   damageElement: 'Physical',

public/icons/weapons/nola.png

@@ -3,6 +3,7 @@ import type { WeaponDefinition } from '../../../models/weapon-definition';
 export const cobaltB = {
   id: 'Cobalt-B',
   displayName: 'Cobalt-B',
+  elementalIcon: 'Flame',
   resonanceElements: ['Flame'],
   calculationElements: ['Flame'],
   damageElement: 'Flame',