Page MenuHomeWildfire Games

correct technology tooltips and formatting
ClosedPublic

Authored by Nescio on Jan 12 2021, 5:05 PM.

Details

Reviewers
Freagarach
Group Reviewers
Restricted Owners Package(Owns No Changed Paths)
Commits
rP24564: Correct technology tooltips and formatting.
Summary
  • This patch standardizes the tooltip text strings per the style guide, for clarity and consistency. This was already done for many, but not all, therefore the need to do it systematically.
  • While at it, properly formats and indents the requirements line where necessary.
  • Furthermore, put every resource cost on a new line, to make inserting new resources easier, and purges 0 entries, as requested elsewhere by @Freagarach.
Test Plan

Check for mistakes and omissions. Everything should still work as before.

Diff Detail

Repository
rP 0 A.D. Public Repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Nescio created this revision.Jan 12 2021, 5:05 PM
Owners added a subscriber: Restricted Owners Package.Jan 12 2021, 5:05 PM

Build is green

builderr-debug-macos.txt
ld: warning: text-based stub file /System/Library/Frameworks//CoreAudio.framework/CoreAudio.tbd and library file /System/Library/Frameworks//CoreAudio.framework/CoreAudio are out of sync. Falling back to library file for linking.
ld: warning: text-based stub file /System/Library/Frameworks//AudioToolbox.framework/AudioToolbox.tbd and library file /System/Library/Frameworks//AudioToolbox.framework/AudioToolbox are out of sync. Falling back to library file for linking.
ld: warning: text-based stub file /System/Library/Frameworks//ForceFeedback.framework/ForceFeedback.tbd and library file /System/Library/Frameworks//ForceFeedback.framework/ForceFeedback are out of sync. Falling back to library file for linking.
ld: warning: text-based stub file /System/Library/Frameworks//CoreVideo.framework/CoreVideo.tbd and library file /System/Library/Frameworks//CoreVideo.framework/CoreVideo are out of sync. Falling back to library file for linking.
ld: warning: text-based stu

See https://jenkins.wildfiregames.com/job/macos-differential/2799/display/redirect for more details.

Nescio requested review of this revision.Jan 12 2021, 5:11 PM
Nescio added inline comments.Jan 12 2021, 5:14 PM
binaries/data/mods/public/simulation/components/Identity.js
68 ↗(On Diff #15187)

Make Immortal a visible class, because it's used by a technology.

binaries/data/mods/public/simulation/data/technologies/attack_cavalry_melee_01.json
27 ↗(On Diff #15187)

Effectively no difference in practice.

binaries/data/mods/public/simulation/data/technologies/attack_cavalry_melee_02.json
28 ↗(On Diff #15187)

idem

binaries/data/mods/public/simulation/data/technologies/attack_cavalry_ranged_01.json
19 ↗(On Diff #15187)

idem

binaries/data/mods/public/simulation/data/technologies/attack_cavalry_ranged_02.json
20 ↗(On Diff #15187)

idem

binaries/data/mods/public/simulation/data/technologies/attack_infantry_melee_01.json
28 ↗(On Diff #15187)

idem

binaries/data/mods/public/simulation/data/technologies/attack_infantry_melee_02.json
21 ↗(On Diff #15187)

idem

binaries/data/mods/public/simulation/data/technologies/attack_infantry_ranged_01.json
27 ↗(On Diff #15187)

idem

binaries/data/mods/public/simulation/data/technologies/attack_infantry_ranged_02.json
28 ↗(On Diff #15187)

idem

binaries/data/mods/public/simulation/data/technologies/attack_soldiers_will.json
21–30 ↗(On Diff #15187)

While entirely differently classes are affected, in practice the effect is still the same. It's done because “Soldiers, Siege Engines, and Ships” is probably more explicit for players than “Melee and Ranged Units”.

binaries/data/mods/public/simulation/data/technologies/gather_animals_stockbreeding.json
3 ↗(On Diff #15187)

Naming specific animals is omitted, because it's conceivable a mod situation in the Americas, or in space, might want to have a corral and use this technology in combination with entirely different animals.

binaries/data/mods/public/simulation/data/technologies/phase_city_generic.json
22 ↗(On Diff #15187)

Missed when rebasing D3315/rP24544.

binaries/data/mods/public/simulation/data/technologies/phase_town_generic.json
22 ↗(On Diff #15187)

idem

Thanks! I was just checking how to do this scripted ;)

binaries/data/mods/public/simulation/data/technologies/attack_cavalry_melee_01.json
27 ↗(On Diff #15187)

More correct at least ;)

binaries/data/mods/public/simulation/data/technologies/attack_soldiers_will.json
30 ↗(On Diff #15187)

Agree.

binaries/data/mods/public/simulation/data/technologies/civbonuses/cart_walls.json
6 ↗(On Diff #15187)

As opposed to palisades?

binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

?

binaries/data/mods/public/simulation/data/technologies/immortals.json
3 ↗(On Diff #15187)

Interesting this doesn't contain an explanation for this tech.

binaries/data/mods/public/simulation/data/technologies/trade_convoys_speed.json
3 ↗(On Diff #15187)

Meh, I'd say it is the other way around. Cause <-> effect.
So I suggest keeping something along the lines of the former string.

Thanks! I was just checking how to do this scripted ;)

Here's a script for indenting json files:


I'm not using it, because I'd like to keep modifications on one line each, which is easier to read when rewriting tooltips (the primary aim of this patch).

binaries/data/mods/public/simulation/data/technologies/civbonuses/cart_walls.json
6 ↗(On Diff #15187)

As opposed to siege walls.

binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

Idle isn't a class.

binaries/data/mods/public/simulation/data/technologies/immortals.json
3 ↗(On Diff #15187)

Many descriptions could use a rewrite, but that's something for the future.

binaries/data/mods/public/simulation/data/technologies/trade_convoys_speed.json
3 ↗(On Diff #15187)

Yes, the higher speed leads to a higher income. Isn't that what it says?

Nescio added inline comments.Jan 12 2021, 6:24 PM
binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

The proposed string follows the format as is already present in several auras:

arsenal_repair.json
cart_super_dock_repair.json
temple_heal.json
brit_hero_cunobelin.json
maur_hero_chanakya_2.json

which were reviewed and accepted by @Gallaecio.

binaries/data/mods/public/simulation/data/technologies/trade_convoys_speed.json
3 ↗(On Diff #15187)

Basically, the purpose of moving faster is to increase your income.
The old string suggests it's merely a corollary.
How about , to increase trade income. instead?

Nah, it is not needed when you have a patch, but thanks anyway :)

binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

But the caveat with the tech is that only idle entities regenerate, which, IMHO should be represented in the tooltip.

binaries/data/mods/public/simulation/data/technologies/trade_convoys_speed.json
3 ↗(On Diff #15187)

Yeah, but the tech enables going faster because the traders use convoys. It is not like: I want more trade, move faster.

But I guess you view is maybe more logical to players.

Nescio added a comment.EditedJan 12 2021, 7:02 PM
This comment has been deleted.
binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

True, but if it's different here, then it should be changed in the auras too. I'm not necessarily opposed to rephrasing, but I believe that discussion belongs outside this patch.

Nescio added inline comments.Jan 12 2021, 7:03 PM
binaries/data/mods/public/simulation/data/technologies/trade_convoys_speed.json
3 ↗(On Diff #15187)

It is not like: I want more trade, move faster.

It's exactly like that!

Yeah, but the tech enables going faster because the traders use convoys.

In reality I'd expect convoys to be slower, not faster, because you have to wait for each other. But that's a different discussion.

Anyway, I'd welcome a more interesting description teaching us something about history, but can't think of something right now that would justify a higher movement speed.

Freagarach added inline comments.Jan 12 2021, 7:07 PM
binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

Why do the other strings need an update? This is the only modification affecting Health/IdleRegenRate.

Nescio added inline comments.Jan 12 2021, 7:11 PM
binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

Oops, you're right, those auras have "Health/RegenRate", not "Health/IdleRegenRate". I didn't know there were two different types of regeneration, well spotted!

Freagarach added inline comments.Jan 12 2021, 7:13 PM
binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

Sorry for not noticing our miscommunication earlier ^^

Nescio added inline comments.Jan 12 2021, 7:15 PM
binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

You're welcome, I learned something new today, that's valuable!
So insert “idle” here. Anything else that needs changing?

Freagarach added inline comments.Jan 12 2021, 7:17 PM
binaries/data/mods/public/simulation/data/technologies/health_regen_units.json
12 ↗(On Diff #15187)

Nope, rest is fine.

Nescio updated this revision to Diff 15197.Jan 12 2021, 7:21 PM
  • insert “idle” in health_regen_units.json tooltip, spotted by @Freagarach
Freagarach accepted this revision.Jan 12 2021, 7:25 PM
  • Nice change, not adding all resources is better for modders (don't need to purge resources that they remove) and us (if we decide to add another resource we don't need to update all techs to be consistent).
  • Complete.
  • Checkrefs passes.
This revision is now accepted and ready to land.Jan 12 2021, 7:25 PM

Build is green

builderr-debug-macos.txt
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/ranlib: file: ../../../binaries/system/libnetwork_dbg.a(precompiled.o) has no symbols
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/ranlib: file: ../../../binaries/system/libsimulation2_dbg.a(precompiled.o) has no symbols
ld: warning: text-based stub file /System/Library/Frameworks//CoreAudio.framework/CoreAudio.tbd and library file /System/Library/Frameworks//CoreAudio.framework/CoreAudio are out of sync. Falling back to library file for linking.
ld: warning: text-based stub file /System/Library/Frameworks//AudioToolbox.framework/AudioToolbox.tbd and library file /System/Library/Frameworks//AudioToolbox.framework/AudioToolbox are out of sync. Falling back to library file for linking.
ld: warning: text-based stub file /System/Library/Frameworks//ForceFeedback.framework/ForceFeedback.tbd and library file /System/Library/Frameworks//Forc

See https://jenkins.wildfiregames.com/job/macos-differential/2805/display/redirect for more details.

This revision was landed with ongoing or failed builds.Jan 12 2021, 7:52 PM
This revision was automatically updated to reflect the committed changes.

Build is green

builderr-debug-gcc7.txt
In file included from ../../../source/third_party/ogre3d_preprocessor/tests/test_Preprocessor.cpp:17:
/zpool0/gcc7/source/third_party/ogre3d_preprocessor/tests/test_Preprocessor.h: In lambda function:
/zpool0/gcc7/source/third_party/ogre3d_preprocessor/tests/test_Preprocessor.h:203:17: warning: unused parameter 'includePath' [-Wunused-parameter]
     const CStr& includePath, CStr& out) {
     ~~~~~~~~~~~~^~~~~~~~~~~
/zpool0/gcc7/source/third_party/ogre3d_preprocessor/tests/test_Preprocessor.h: In lambda function:
/zpool0/gcc7/source/third_party/ogre3d_preprocessor/tests/test_Preprocessor.h:220:17: warning: unused parameter 'includePath' [-Wunused-parameter]
     const CStr& includePath, CStr& out) {
     ~~~~~~~~~~~~^~~~~~~~~~~
/zpool0/gcc7/source/third_party/ogre3d_preprocessor/tests/test_Preprocessor.h:220:36: warning: unused parameter 'out' [-Wunused-parameter]
     const CStr& includePath, CStr& out) {
/zpool0/gcc7/source/third_party/ogre3d_preprocessor/test

See https://jenkins.wildfiregames.com/job/docker-differential/4468/display/redirect for more details.