Effective Locales

[lukashert]

Adds Player#setEffectiveLocale(Locale) / Player#getEffectiveLocale() to set and get a player-specific locale, which is used for server-side translations.

Closes #10570

[lynxplay]

I am semi uncertain on the naming "effective locale".
I know this mirrors velocity's API, however in the context of velocity, it being "effective" makes sense, given that all of velocity's messages are using the global translator to be resolved.

This differs drastically on backend servers like paper, where basically none of the messages sent are actually translated on the server side beyond plugin messages. Command feedback, server system messages, etc are all not translated on the server but instead resolved by the client itself.
Given I don't have an immediate better idea for the naming, nor am I sure this change in naming is 100% needed, I'll throw this at the rest of team/contributors.

[davidmayr]

Given I don't have an immediate better idea for the naming, nor am I sure this change in naming is 100% needed, I'll throw this at the rest of team/contributors.

How about just mentioning what that locale actually does in the javadoc?

[lynxplay]

Well, javadocs are a nice tool. But they are generally a second resort and do not save us from poorly named methods.
A user looking for a way to force a locale will still run into Player#setEffectiveLocale and just not read those docs until already hammering their head into a wall as to why it isn't working.

[Doc94]

try put this in the same line because the comment only apply to the field and not this.

[davidmayr]

Well, javadocs are a nice tool. But they are generally a second resort and do not save us from poorly named methods. A user looking for a way to force a locale will still run into Player#setEffectiveLocale and just not read those docs until already hammering their head into a wall as to why it isn't working.

I mean, I agree. But then again, there are no better name suggestions yet. And I think it makes sense to mention it regardless

[lynxplay]

Yea certainly a good point to expand the javadocs here regardless 👍

[kezz]

Seeing as Velocity also has this and Adventure has a lot of requests of users wanting to override the locale used for server-side translating, I've gone ahead and opened a PR to implement this in Adventure directly, which also solves the issue this PR has about confusing developers. PaperMC/adventure#1221

[Brokkonaut]

How about Player.get/setServerSideLocale() ?

[lynxplay]

Yea, setServerSideLocale is a nice name, however the adventure PR might be nicer.

[Owen1212055]

Seeing above, I am going to go ahead and close this PR.

Thank you so much for your contribution, but this will be much better supported natively by the adventure PR listed above.