Translation Generation

[feldoh]

from cursor position in the xml enable generating a translation string:

• in the label for Steel generates <Steel.label></Steel.label>
• in a list creates the appropriate list item string or comp based navigation if viable

[Garethp]

in a list creates the appropriate list item string or comp based navigation if viable

Can you expand on this with examples? With my lack of knowledge of translations I'm not sure what you mean

[feldoh]

https://github.com/MrSamuelStreamer/RPGFantasyFlavourMod/blob/main/CONTRIBUTING.md
provides a base set of examples and a decent description except for the comp based bit which I didn't understand myself at the time.

When you have a comp list

<HediffDef ParentName="AddedBodyPartBase">
    <defName>BionicArm</defName>
    ...
    <comps>
      <li Class="HediffCompProperties_VerbGiver">
        <tools>
          <li>
            <label>fist</label>
            ...
          </li>
        </tools>
      </li>
    </comps>
    ...
</HediffDef>

Weirdly you can target things within the comp by using the index of the comp or resolving it to a class and using the actual Comp's class name, because you're translating the real class not the props object. This seems to work wherever you are using <li Class="XYZProperties">

Within list items that aren't disambiguated by class you seem to be able to use <label> as a selector instead where that exists. So all four of these are equivalent:

<BionicArm.comps.0.tools.0.label>TODO</BionicArm.comps.0.tools.0.label>
<BionicArm.comps.0.tools.fist.label>TODO</BionicArm.comps.0.tools.fist.label>
<BionicArm.comps.HediffComp_VerbGiver.tools.0.label>TODO</BionicArm.comps.HediffComp_VerbGiver.tools.0.label>
<BionicArm.comps.HediffComp_VerbGiver.tools.fist.label>TODO</BionicArm.comps.HediffComp_VerbGiver.tools.fist.label>

Resolving the comp HediffCompProperties_VerbGiver -> HediffComp_VerbGiver
Resolving the tool by label
Resolving either by index

I believe this is all backed by the [TranslationHandle] attribute. The fields that are annotated like this are viable sources for the translation handle in lists and will fall back to index so it should be predictable in the generator as you'll have both class and XML. Check out TranslationHandleUtility.GetBestHandleWithIndexForListElement and TranslationHandleUtility.GetBestHandleWithIndexForListElement for the non-list normal cases.

Plausibly you could even just call TranslationHandleUtility.GetBestHandleWithIndexForListElement

The main wiki also has a decent summary https://rimworldwiki.com/wiki/Modding_Tutorials/Localization

[feldoh]

Personally I prefer to not rely on the positional translations because XML patches can absolutely destroy that and make it impossible to translate stuff you know is added by a mod. But you can see the handle stuff is so complex, it's hard to work out, hence why this would actually be so useful