Add generateRelative function

[dumbmatter]

This PR adds a generateRelative function which takes an existing face object and a gender and returns a new face object that is fairly similar to the existing one, but with some differences. Basically like an immediate family member.

It does this by regenerating only some properties from the input face, and others are just passed through without change. (The fraction of regenerated properties could be another parameter so you could create cousins or whatever, but I don't need that feature personally and I'm not sure if anyone else does.)

Here's an example of generating a chain of 6 relatives:

You can try it in the editor, I added a new option:

I don't love that UI because it looks kind of lonely having one option in "Other", and also because currently when you enable "Relative" it ignores the race options and the locked features. But I'm not sure what would be better.

Also I made this a separate function generateRelative rather than having it as another option in generate because it doesn't work with the existing overrides and race options, so I think it's less confusing as a separate function.

Fixes #5

[dumbmatter]

@tomkennedy22 want to review my PR? No worries if you're too busy just lmk :)

[tomkennedy22]

@tomkennedy22 want to review my PR? No worries if you're too busy just lmk :)

Would be happy to, will take a look tonight 👍

[tomkennedy22]

Overall it works well! Nice work.

I left a few small food-for-thought comments, but all take it or leave it

[tomkennedy22]

Probably a non-issue now (and likely ever), but if multiple races share a skin color, might have conflict w/ this function

[dumbmatter]

Yeah... it would also break if the default skin colors change (unless the old defaults are kept around for this function). But I think it's good enough for now, we just need to remember to deal with it if a future update introduces an issue.

[tomkennedy22]

I wonder with these lines (30 ➡️ 56) if we have a master list of properties already defined, and then we just toggle some in & out of regenerate? To save from effectively defining two MECE lists back to back

[dumbmatter]

I had to google MECE but that is a good acronym, and this is also a good point. The tricky part is getting TypeScript to enforce that the list is actually exhaustive, but I think it's possible...

[dumbmatter]

This is pretty nice now! TypeScript will error if anything is ever added to FaceConfig that makes this no longer exhaustive. And it lets you choose if you want to operate on an entire object (like accessories) or an exhaustive list of individual properties (like body).

  const regenerateProperties: RegenerateProperties = {
    accessories: "always",
    body: {
      color: "sometimesIfRaceIsKnown",
      id: "sometimes",
      size: "always",
    },
    ear: "sometimes",
    eye: "sometimes",
    eyebrow: "sometimes",
    eyeLine: "sometimes",
    facialHair: "always",
    fatness: "always",
    glasses: "always",
    hair: {
      color: "sometimesIfRaceIsKnown",
      flip: "always",
      id: "always",
    },
    hairBg: "always",
    head: {
      id: "sometimes",
      shave: "always",
    },
    jersey: "never",
    miscLine: "sometimes",
    mouth: "sometimes",
    nose: "sometimes",
    smileLine: "sometimes",
    teamColors: "never",
  };

[tomkennedy22]

Nice! Clever way of doing it

[tomkennedy22]

I'm a fan of all of these additions :D

[tomkennedy22]

I think this was my fault originally, but should genders & races be imported from common as well?