[RDY] Customize Consume Item menu

[codemime]

Follows #19952 and #18681.

Overview

• The usable information and various reasons why you can't consume stuff are shown.
  

• CBMs that turn items into energy became more UI friendly:
  
  

• All the "queries" are now asked at once. No more annoying repetition of "Really eat that?":
  

• "Smart" sorting order:
  

  • Rotten food goes last unless you're a saprophagous (then it goes first).
  • Perishable food goes before long-lasting one (preservation and freshness were taken into account).
  • If you're thirsty, food gets sorted by QUENCH, otherwise by NUTRITION.
  • Then by what remains (either NUTRITION or QUENCH).
  • Then by JOY.
  • Then by ENERGY (in case of active CBMs).

[Coolthulhu]

The interface would be cleaner if the return value included the error - return by parameter is C-ish.
For example, if you returned it as a const std::pair<edible_rating, std::string> &.

[codemime]

The interface would be cleaner if the return value included the error - return by parameter is C-ish.

Agreed. For now, I've simply repeated the signature of player::can_eat

For example, if you returned it as a const std::pair<edible_rating, std::string> &

I was thinking about that too and came up with a template class. Something like this:

template<typename T = bool, T no_error = true, T default_error = false>
class ret_val
{
    public:
        static_assert( no_error != default_error, "Error codes must differ." );

        ret_val() = delete;

        static ret_val success( const std::string &msg = std::string() ) {
            return ret_val( no_error, msg );
        }

        static ret_val failure( T code = default_error, const std::string &msg = std::string() ) {
            return ret_val( default_error, msg );
        }

        operator bool() const {
            return code == no_error;
        }

        T operator *() const {
            return code;
        }

        const std::string &str() const {
            return msg;
        }

        const char *c_str() const {
            return msg.c_str();
        }

    protected:
        ret_val( T code, const std::string &msg ) : code( code ), msg( msg ) {}

    private:
        std::string msg;
        T code;
};

I think this should be done in a separate PR for all related cases.

[Coolthulhu]

I'm not sure if that sorting is a good idea, at least not without a way to turn it off.
One very important quality of menus is that they do not change if they don't need to: that they keep dimensions and contents as consistent as possible.

Is there a different item menu that is sorted by default? If not, this one should only be sorted once the player presses some sort/filter button.

[codemime]

I'm not sure if that sorting is a good idea, at least not without a way to turn it off.

Neither am I. That's mostly why I put the CR tag.

One very important quality of menus is that they do not change if they don't need to: that they keep dimensions and contents as consistent as possible.

They'd be more stable if sorted by NUTRITION only. Or even solely by freshness/spoilage (as an extreme). I do think that the latter is a good idea.

Is there a different item menu that is sorted by default?

Gunmod menu is sorted using the installation odds.

If not, this one should only be sorted once the player presses some sort/filter button.

As for now, there's no way we can toggle sorting. This probably needs to be implemented.

[Coolthulhu]

The display is generally fine on a sane setting, but our defaults are not sane: at 80 screen width, the new display columns force inventory columns (from map, from vehicle etc.) below the inventory ones, halving the number of items displayed.
Now, 80 screen width is generally rather painful and I wouldn't recommend playing with such a narrow viewport, but it is the default and thus we're supposed to support it.
Is there a way to compress the display to force the 2 columns if there is only one?

If not, I'll wait for others to approve. It's fine by me, but not necessarily for everyone else.

As for the smart sorting:
This one sounds like it could be painful in some cases (finding specific joy item in a huge stash etc.). I'd add an option (as in, options.cpp option) to disable it, at least at first. It can be the default, just that it shouldn't be the only option until we can sort it all out.

One thing could really help with everything here:
Being able to filter the inventory in a similar way all uimenus are filtered. If this was implemented, the sorting would be totally fine in pretty much all cases.

[codemime]

Is there a way to compress the display to force the 2 columns if there is only one?

Doable, but I doubt that makes sense. Long rows would either overlap each other or simply won't fit. BTW I didn't change column management in this PR.

This one sounds like it could be painful in some cases. I'd add an option (as in, options.cpp option) to disable it, at least at first. It can be the default, just that it shouldn't be the only option until we can sort it all out.

That would be equally painful with lists sorted alphabetically, but the option is an option.

Being able to filter the inventory in a similar way all uimenus are filtered.

I thought about that too and I'm going to implement that.

[codemime]

I have resolved the merge conflict and removed all additional sorting except by freshness.

[Coolthulhu]

Typo

[Coolthulhu]

What will be the context of this message?
You removed questions from other messages, why not this one?

[codemime]

I probably wasn't careful enough during merging.

[Coolthulhu]

Why return the first one? Does it matter?

[codemime]

It does matter mostly for the colors in the inventory menu. Another option is choosing the most severe out of multiple choices.

[codemime]

I have reordered the consequences by severity (the order is arguable):

Type	Consequences
Rotten	Food poisoning, health damage
Cannibalism	Long lasting morale penalty
Nausea	Losing eaten food, hunger, thirst, morale penalty
Allergy	Morale penalty that lasts half as long as for cannibalism
Too full	Risk of sudden vomiting
Won't eat	No ill effects

[Coolthulhu]

Is this regarding the return value?
Would be cleaner with "Can" in front.

[Coolthulhu]

That prompt for "really burn x for energy" is really annoying. I assume it is to prevent burning weapons and such, but this needs to be special cased for "quality" items, otherwise it will lead to common annoyance to prevent a rare edge case.
I don't see a good way of sneaking that prompt in somehow.

Also double prompt when eating something burnable for fuel that is edible. Double Y/N queries (other than "are you really, really sure? this will probably have horrible results") are pretty much always wrong and can only ever be lesser evil, not the proper solution.
After removing the "really burn" prompt, this could be fixed by simply not allowing burning edible things. Edible things are generally bottles and boxes - if someone really wants to eat one, they'll empty it and then eat the bottle, not burn a bottle filled with water.

When the furnace is turned on, burnable food containers are colored as if inedible.
Would be fixed by simply not treating them as burnable.

[Coolthulhu]

Also a bug, but I'm not sure if it's introduced here:

• Spawn contained fast food french fries
• Drop all worn containers so that your free carrying capacity is zero
• Try to eat the fries

This will result in "Too big to pick up", even though you are trying to eat them, not hold them in the inventory.
Eating isn't a long action that requires eaten items to reside in inventory. Eating from the table is perfectly fine.

[Coolthulhu]

Fails bionic test:

bionics_test.cpp:56: FAILED:

  REQUIRE( p.can_consume( it ) == when_none )

with expansion:

  false == true

with messages:

  no power capacity at first

  adding Power Storage CBM only increases capacity

  'battery' is count-by-charges

  consume 'battery' with 0 charges

[codemime]

The test was failing because it's assumed that discharged batteries can still be used to recharge the power storage. Seems quite impossible to reproduce with the count_by_charges item, so no big deal.

[codemime]

All set.