New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Pedia] Add info to entries in the "Meter Type/" Pedia category #1880

Open
alleryn opened this Issue Nov 26, 2017 · 10 comments

Comments

Projects
None yet
4 participants
@alleryn
Contributor

alleryn commented Nov 26, 2017

See also the forum thread http://www.freeorion.org/forum/viewtopic.php?f=28&t=10776

There is some missing info that perhaps ought to be added to some of the "Meter_Type/" entries in the Pedia:

  • "Imperial Stockpile Use Limit" is empty [FIXED in a83bfc5]
  • "Industry" needs some editing to account for the introduction of the Imperial Stockpile. [FIXED in a83bfc5]
  • The "Stat - Primary" and "Stat - Secondary" entries are vague at best. There should probably be at least a little info added to the entries, to indicate what they are intended to be used for. Currently they are used only for ship parts (?), but may have other uses in the future (what uses?). It may also be a good idea to name these to something more specific, lest they fall into some sort of "catch-all" status.
  • Other entries may be worth looking at, possibly including "Rebel Troops" (maybe a note that these aren't yet implemented?) and/or "Size" (currently rather vague).
@alleryn

This comment has been minimized.

Show comment
Hide comment
@alleryn

alleryn Nov 26, 2017

Contributor

Poking around in https://github.com/freeorion/freeorion/blob/master/default/stringtables/en.txt it looks like METER_IMPERIAL_PP_USE_LIMIT_VALUE_LABEL may be somewhere, where it should say METER_IMPERIAL_PP_USE_LIMIT_VALUE

METER_IMPERIAL_PP_USE_LIMIT_VALUE_LABEL

Also to be conistent, METER_IMPERIAL_PP_USE_LIMIT_VALUE should probably be changed to METER_IMPERIAL_PP_USE_LIMIT_VALUE_DESC in en.txt

I'm checking to see if it's in any of the other language files.... and it looks like that entry has been translated only into french so far.

So en.txt and fr.txt for the METER_IMPERIAL_PP_USE_LIMIT_VALUE --> METER_IMPERIAL_PP_USE_LIMIT_VALUE_DESC if desired for consistency.

I think this is helpful information, but if not, please disregard.

Contributor

alleryn commented Nov 26, 2017

Poking around in https://github.com/freeorion/freeorion/blob/master/default/stringtables/en.txt it looks like METER_IMPERIAL_PP_USE_LIMIT_VALUE_LABEL may be somewhere, where it should say METER_IMPERIAL_PP_USE_LIMIT_VALUE

METER_IMPERIAL_PP_USE_LIMIT_VALUE_LABEL

Also to be conistent, METER_IMPERIAL_PP_USE_LIMIT_VALUE should probably be changed to METER_IMPERIAL_PP_USE_LIMIT_VALUE_DESC in en.txt

I'm checking to see if it's in any of the other language files.... and it looks like that entry has been translated only into french so far.

So en.txt and fr.txt for the METER_IMPERIAL_PP_USE_LIMIT_VALUE --> METER_IMPERIAL_PP_USE_LIMIT_VALUE_DESC if desired for consistency.

I think this is helpful information, but if not, please disregard.

@alleryn

This comment has been minimized.

Show comment
Hide comment
@alleryn

alleryn Nov 26, 2017

Contributor

Update: It turned out that tacking on that _DESC was all that was needed. I have the "Imperial Stockpile Use Limit" entry displaying properly now.

Contributor

alleryn commented Nov 26, 2017

Update: It turned out that tacking on that _DESC was all that was needed. I have the "Imperial Stockpile Use Limit" entry displaying properly now.

@alleryn

This comment has been minimized.

Show comment
Hide comment
@alleryn

alleryn Nov 27, 2017

Contributor

Further proposed changes:

  • "Stat - Primary" --> "Ship Part Capacity" : "The Capacity of a Ship Part describes its primary function: Shield Strength for Shields, Fighter Capacity for Hangars, population for Colony Pods, etc."

  • "Stat - Secondary" --> "Ship Part Secondary" : "Used as a supplement for [[metertype METER_CAPACITY]] (ed. note: would read "Stat - Primary" or "Ship Part Capacity") when additional information about a ship part is required, for example Shot Damage for a Hangar (to supplement Fighter Capacity) or Shots per Attack for a Flak Cannon (to supplement Shot Damage)."

  • "Size" --> "Field Size" :

  1. "Measures the size of a field. A list of the various types of fields can be found at [[encyclopedia ENC_FIELD_TYPE]]."
  2. Alternate: "Measures the radius of a [[encyclopedia ENC_FIELD_TYPE]] (ed. note: would read "Field Type")."
  3. Alternate: "Measures the size of a field. A list of [[encyclopedia ENC_FIELD_TYPE]]s is available on the Pedia."
  • "Industry": "...Any un-allocated Industry is lost each turn. ..." --> "...Any un-allocated Industry is converted via the [[metertype METER_IMPERIAL_PP_TRANSFER_EFFICIENCY]] (ed. note: would read "Industry to Stockpile PP Transfer Ratio") and added to the Imperial Stockpile. ..."
Contributor

alleryn commented Nov 27, 2017

Further proposed changes:

  • "Stat - Primary" --> "Ship Part Capacity" : "The Capacity of a Ship Part describes its primary function: Shield Strength for Shields, Fighter Capacity for Hangars, population for Colony Pods, etc."

  • "Stat - Secondary" --> "Ship Part Secondary" : "Used as a supplement for [[metertype METER_CAPACITY]] (ed. note: would read "Stat - Primary" or "Ship Part Capacity") when additional information about a ship part is required, for example Shot Damage for a Hangar (to supplement Fighter Capacity) or Shots per Attack for a Flak Cannon (to supplement Shot Damage)."

  • "Size" --> "Field Size" :

  1. "Measures the size of a field. A list of the various types of fields can be found at [[encyclopedia ENC_FIELD_TYPE]]."
  2. Alternate: "Measures the radius of a [[encyclopedia ENC_FIELD_TYPE]] (ed. note: would read "Field Type")."
  3. Alternate: "Measures the size of a field. A list of [[encyclopedia ENC_FIELD_TYPE]]s is available on the Pedia."
  • "Industry": "...Any un-allocated Industry is lost each turn. ..." --> "...Any un-allocated Industry is converted via the [[metertype METER_IMPERIAL_PP_TRANSFER_EFFICIENCY]] (ed. note: would read "Industry to Stockpile PP Transfer Ratio") and added to the Imperial Stockpile. ..."
@agrrr3

This comment has been minimized.

Show comment
Hide comment
@agrrr3

agrrr3 Nov 28, 2017

Contributor
Contributor

agrrr3 commented Nov 28, 2017

@alleryn

This comment has been minimized.

Show comment
Hide comment
@alleryn

alleryn Nov 28, 2017

Contributor

Any un-allcoated --> Any un-allocated

Nice catch, fixed above.

Contributor

alleryn commented Nov 28, 2017

Any un-allcoated --> Any un-allocated

Nice catch, fixed above.

@alleryn

This comment has been minimized.

Show comment
Hide comment
@alleryn

alleryn Nov 28, 2017

Contributor

Re-worded the Field Size entry suggestion.

Contributor

alleryn commented Nov 28, 2017

Re-worded the Field Size entry suggestion.

@geoffthemedio

This comment has been minimized.

Show comment
Hide comment
@geoffthemedio

geoffthemedio Nov 30, 2017

Member

Weapon parts have damage, not "capacity".

Member

geoffthemedio commented Nov 30, 2017

Weapon parts have damage, not "capacity".

@alleryn

This comment has been minimized.

Show comment
Hide comment
@alleryn

alleryn Nov 30, 2017

Contributor

Weapon parts have damage, not "capacity".

METER_CAPACITY seems to be used for weapon part damage here:

float part_attack = ship->CurrentPartMeterValue(METER_CAPACITY, part_name);

Or am i reading this incorrectly?

Contributor

alleryn commented Nov 30, 2017

Weapon parts have damage, not "capacity".

METER_CAPACITY seems to be used for weapon part damage here:

float part_attack = ship->CurrentPartMeterValue(METER_CAPACITY, part_name);

Or am i reading this incorrectly?

@alleryn

This comment has been minimized.

Show comment
Hide comment
@alleryn

alleryn Dec 1, 2017

Contributor

Some of this seems like it'll take quite a while to sort out, so i figured i'd try to push through the minor stuff:
#1895

That is intended to take care of "Imperial Stockpile Use Limit" and "Industry" (the french article for the latter still says that unused industry points are wasted, rather than converted into stockpile points... i just left a note in fr.txt that it needs an update).

Beyond that, it feels like a bit of a morass to me.

METER_CAPACITY seems to be doing a lot of things at once and require extra syntax in a number of places since sometimes it's referred to textually as "Capacity" and other times as ""Damage", and in the Pedia as "Stat - Primary".

It also is used at least once just as a literal "Capacity", when the player opens the pedia to look at a ship design, for Fuel [[METER_CAPACITY]]. In this case perhaps it would be better replaced by [[LITERAL_CAPACITY]] since it's really not being used as a meter in this context.

[[METER_SIZE]] is also a bit overloaded, referring to both the discrete quantity Fleet Count, and the continuous quantity Field Radius.

I'd recommend moving further discussions at this point to the forum http://www.freeorion.org/forum/viewtopic.php?f=28&t=10776 unless someone has a more concrete understanding than me of these issues.

Contributor

alleryn commented Dec 1, 2017

Some of this seems like it'll take quite a while to sort out, so i figured i'd try to push through the minor stuff:
#1895

That is intended to take care of "Imperial Stockpile Use Limit" and "Industry" (the french article for the latter still says that unused industry points are wasted, rather than converted into stockpile points... i just left a note in fr.txt that it needs an update).

Beyond that, it feels like a bit of a morass to me.

METER_CAPACITY seems to be doing a lot of things at once and require extra syntax in a number of places since sometimes it's referred to textually as "Capacity" and other times as ""Damage", and in the Pedia as "Stat - Primary".

It also is used at least once just as a literal "Capacity", when the player opens the pedia to look at a ship design, for Fuel [[METER_CAPACITY]]. In this case perhaps it would be better replaced by [[LITERAL_CAPACITY]] since it's really not being used as a meter in this context.

[[METER_SIZE]] is also a bit overloaded, referring to both the discrete quantity Fleet Count, and the continuous quantity Field Radius.

I'd recommend moving further discussions at this point to the forum http://www.freeorion.org/forum/viewtopic.php?f=28&t=10776 unless someone has a more concrete understanding than me of these issues.

@geoffthemedio

This comment has been minimized.

Show comment
Hide comment
@geoffthemedio

geoffthemedio Dec 1, 2017

Member

The capacity meter is used internally for most part stats, particularly the "primary" stat. To the player, for a weapon part, the primary stat is the part's damage.

Member

geoffthemedio commented Dec 1, 2017

The capacity meter is used internally for most part stats, particularly the "primary" stat. To the player, for a weapon part, the primary stat is the part's damage.

@Vezzra Vezzra modified the milestones: v0.4.8 (optional), post 0.4.8 Jun 6, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment