Pockets: soft nested containers respect priority settings

[dseguin]

Summary

None

Purpose of change

• Fixes Nested dimensional bag (Magiclysm) is not filling first even when set as highest priority with auto pickup settings. #57675

#54941 made it so that items are never inserted into soft nested pockets. The rationale was that it doesn't improve volume management and only increases the retrieval cost of the item. The issue is that some containers have special properties despite being "soft", like the dimensional bag from Magiclysm.

Players should expect that manually setting pocket priority takes precedent over whether it's soft or not.

Describe the solution

Respect pocket priority settings when inserting items into containers.

Describe alternatives you've considered

Adding flags/fields to pocket data for specifying special priority behaviours.

Testing

Added a couple of test cases to verify that pocket priority is respected for any nested container:

tests/cata_test --rng-seed time "picking up items respects pocket autoinsert settings"

Additional context