Page MenuHomeWildfire Games

standardize resource tooltips
ClosedPublic

Authored by Nescio on Jun 23 2019, 7:07 PM.

Details

Summary

This patch:

  • remove <Type>stone.ruins</Type> from specific gaia/ruins/ templates, because already defined in generic parent template
  • removed <Type>treasure.metal</Type> from template_gaia_treasure.xml because all its children define their own <Type>
  • remove tooltips from specific gaia/ templates, because already defined in generic parent template
  • standardizes the tooltips of resource templates to "[verb] [subtype] for [resources]."
    • preceded by "Kill to" if <KillBeforeGather>true</KillBeforeGather>
  • treasure tooltip is formulated slightly differently (but similar)
  • farm field is already done in D1803

[EDIT]: Potential ideas for future patches:

  • reduce duplication in flora and geo templates by replacing:
template_gaia_flora.xml
template_gaia_flora_bush.xml
template_gaia_flora_bush_berry.xml
template_gaia_flora_tree.xml
template_gaia_flora_tree_fruit.xml
template_gaia_geo.xml
template_gaia_geo_mineral.xml
template_gaia_geo_mineral_slabs.xml
template_gaia_geo_rock.xml
template_gaia_geo_rock_slabs.xml

with:

template_gaia_fruit.xml
template_gaia_ore.xml
template_gaia_ore_small.xml
template_gaia_rock.xml
template_gaia_rock_small.xml
template_gaia_tree.xml
  • might also want to deprecate template_gaia_geo.xml because it has little added value
  • merge template_unit_fauna_herd.xml with its one and only child,*_domestic.xml
  • change whale resource type from fish to meat, to be consistent with other fauna, and to allow fishing boats to have different gather rates for fish and whales (requires meat gather animations, though)
Test Plan

Check for mistakes.

Diff Detail

Repository
rP 0 A.D. Public Repository
Branch
/ps/trunk
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 8051
Build 13103: Vulcan BuildJenkins
Build 13102: arc lint + arc unit

Event Timeline

Nescio created this revision.Jun 23 2019, 7:07 PM
Nescio edited the summary of this revision. (Show Details)
Nescio edited the summary of this revision. (Show Details)Jun 23 2019, 7:10 PM
Nescio edited the summary of this revision. (Show Details)

Successful build - Chance fights ever on the side of the prudent.

Link to build: https://jenkins.wildfiregames.com/job/differential/1798/display/redirect

I’ve left a few comment. However, I’m not in a position to review the changes as a whole, I unsure whether or not the element removals are OK. Please, add other reviewers for those.

binaries/data/mods/public/simulation/templates/template_gaia_flora.xml
6

I would actually go with “Chop for wood” or “Chop this tree for wood”, and I suggest a similar change for all other cases below where the word refers to the entity as a whole (ore, rock, etc.).

binaries/data/mods/public/simulation/templates/template_unit_fauna_herd.xml
7

“Kill for food” would seem more in line with your other changes to me. Same on the other changes below.

So basically you prefer [verb] for [resource] instead of [verb] [subtype] for [resource]?

In D2006#90693, @Nescio wrote:

So basically you prefer [verb] for [resource] instead of [verb] [subtype] for [resource]?

Not really.

I don’t like “Chop tree for wood”, it feels like “robot language“ to me.
I prefer “Chop this tree for wood”, “Chop for wood” or “Chop trees for wood”.

As for “Kill to take meat for food” and similar, I think the “to take meat” part is unnecessary and inconsistent with your previous choices (think of “Chop to take lumbers for wood”).

Units have different gather rates for resource subtypes, therefore it makes sense to mention both the subtype (what you gather) and the resource (what you gather) in the tooltip. We already have “Harvest grain for food.” in the field tooltip and my suggestion is to follow that format for the other resource entity tooltips. Flora has wood.tree or food.fruit. And animals have to be killed before resources can be collected, hence the “Kill to”.
But yeah, sentences should be proper English; robot language is undesirable.
(Also, lumber is something quite different than wood; look it up in a dictionary.)

In D2006#90946, @Nescio wrote:

Units have different gather rates for resource subtypes, therefore it makes sense to mention both the subtype (what you gather) and the resource (what you gather) in the tooltip.

That makes a lot of sense.

(Also, lumber is something quite different than wood; look it up in a dictionary.)

Damn, I was actually thinking of trunk/log (https://www.wordreference.com/es/en/translation.asp?spen=tronco)

Nescio updated this revision to Diff 9513.Aug 25 2019, 8:31 PM

Successful build - Chance fights ever on the side of the prudent.

Link to build: https://jenkins.wildfiregames.com/job/docker-differential/494/display/redirect

Gallaecio accepted this revision.Sep 1 2019, 12:28 PM
This revision is now accepted and ready to land.Sep 1 2019, 12:28 PM
This revision was automatically updated to reflect the committed changes.