Rework the auto translation system

[YeldhamDev]

Closes godotengine/godot-proposals#8897.

This PR adds the auto_translate_mode member to Node, deprecating auto_translate in Control and Window. This not only removes the need for duplicate code between those two, but also makes it easier to add it to other node types in the future as well (such as Label3D). atr() was also moved to Node for the same reasons above.

Here's a list of the available modes:

• AUTO_TRANSLATE_MODE_ALWAYS - Makes auto_translate work exactly as it does now.
• AUTO_TRANSLATE_MODE_INHERIT - The new default, inherits the auto_translate value of its parent.
• AUTO_TRANSLATE_MODE_DISABLED - The same as if auto_translate was toggled off.

The new default slight breaks compatibility, but I think it's for the better.

[YeldhamDev]

@AThousandShips Changes made.

[Mickeon]

Where's the "new default" in the current version of this PR? I don't think I see it.

Edit: Ok, I understand now.

Although, I do have a feeling that there could be a way to remove auto_translate and still maintain compatibility by manipulating _set() and _get() like some other classes do (such as RectangleShape2D's extents).

[timothyqiu]

Can we deprecate auto_translate, and make auto_translate_mode one of DISABLED, INHERIT, and ALWAYS?

To keep things compatible, make auto_translate backed by auto_translate_mode under the hood.

• If existing code sets auto_translate, set auto_translate_mode to DISABLED / ALWAYS accordingly.
• Hide auto_translate in the Inspector and don't save it when saving the scene.
  • If exsiting scene enabled it, auto_translate_mode will be updated when opening the scene.

[akien-mga]

Can we deprecate auto_translate, and make auto_translate_mode one of DISABLED, INHERIT, and ALWAYS?

To keep things compatible, make auto_translate backed by auto_translate_mode under the hood.

* If existing code sets `auto_translate`, set `auto_translate_mode` to `DISABLED` / `ALWAYS` accordingly.

* Hide `auto_translate` in the Inspector and don't save it when saving the scene.
  
  * If exsiting scene enabled it, `auto_translate_mode` will be updated when opening the scene.

Yes, this can be done by handling auto_translate is _set/_get, it doesn't even need a property registered formally (so there's no need to hide it).

[YeldhamDev]

@timothyqiu @akien-mga The methods themselves would still need to be registered, right? To maintain GDNative compatibility I mean.

[akien-mga]

@timothyqiu @akien-mga The methods themselves would still need to be registered, right? To maintain GDNative compatibility I mean.

Yeah, but they can be registered as compat bindings. See e.g. scene/2d/tile_map.compat.inc for an example of how it's done.

Alternatively, we can keep the methods registered as normal methods and the property registered too, and mark them deprecated. Both options should be fine.

[YeldhamDev]

Alright, with the increasing number of nodes that need auto translation that don't inherit Control, I think moving the auto translation properties back to Node is the only sane way forward.

[YeldhamDev]

The PR has been heavily reworked, please see the updated OP.

[YeldhamDev]

This PR is ready.

[Mickeon]

I don't have anything against the documentation. I'm still questioning the usefulness of atr and atr_n. I'm in the opinion that a method called can_auto_translate() would be more generally useful and less confusing, but I'm not going to cry in my sleep about it.

[akien-mga]

Quick code review. Looks good!
Still have to actually test.

[akien-mga]

Just food for thought - is this something that could be streamlined together with the added auto_translate_mode, maybe adding enum values that enable both translation + numbers localization?

May not be a good idea, but just leaving this here for consideration.

[YeldhamDev]

As much as I like the idea, how many extra options that would add? I feel like it would make it a little convoluted.

[akien-mga]

Yeah I don't really see how it would work to be honest :D

[Mickeon]

Clamping it all together in a BitField of some sort sounds interesting...

[akien-mga]

I tested it with this scene setup:

With Auto Translate disabled on FileDialog, and after setting the project test locale to fr and importing editor/translations/editor/fr.po as translations, it seems like the internal nodes of the dialog still get translated automatically. Only the dialog title seems to stay in English (and gets translated with Auto Translate enabled).

With Inherit/Always:

With Disabled:

MRP: autotranslate_filedialog.zip

[YeldhamDev]

@akien-mga

With Auto Translate disabled on FileDialog, and after setting the project test locale to fr and importing editor/translations/editor/fr.po as translations, it seems like the internal nodes of the dialog still get translated automatically. Only the dialog title seems to stay in English (and gets translated with Auto Translate enabled).

I fixed the part that this PR affects, however, this will be only fixed completely with #86222, since this bug occurs because those strings are translated before being given to the button.

[YeldhamDev]

Changes made.

[akien-mga]

Thanks!