vehicles: simplify specifying directional variants of vehicle parts #42803
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mlangsdorf
added
SDL: Tiles / Sound
mlangsdorf
force-pushed
the
vpart_simplified
branch
2 times, most recently
from
788693c
to
7a4548a
Compare
|
I can send you the vp IDs or just edit them in myself if it makes your life easier. |
I-am-Erk
reviewed
Aug 10, 2020
I-am-Erk
reviewed
Aug 10, 2020
I-am-Erk
reviewed
Aug 10, 2020
I-am-Erk
reviewed
Aug 10, 2020
mlangsdorf
force-pushed
the
vpart_simplified
branch
6 times, most recently
from
e17f2b3
to
9990681
Compare
I-am-Erk
reviewed
Aug 13, 2020
I-am-Erk
reviewed
Aug 14, 2020
mlangsdorf
force-pushed
the
vpart_simplified
branch
from
9990681
to
f61c4a0
Compare
instead of having 8-9 different vehicle part JSON definitions for boards, quarterpanels, and frames that differ only by id and symbol, have a single vehicle part JSON definition that has multiple symbols. Make this transparent for mods by parsing the vehicle part id for the standard variants (cover, cross, horizontal, etc).
…suals Convert the standard "bus" vehicle to use "parts" arrays instead of long lists of "part", and use some of the new directional part variants to make the bus look better under tiles.
mlangsdorf
force-pushed
the
vpart_simplified
branch
from
f61c4a0
to
4a3e9e2
Compare
I-am-Erk
reviewed
Aug 16, 2020
|
This pull request has been mentioned on Cataclysm: Dark Days Ahead. There might be relevant details there: |
kevingranade
pushed a commit
that referenced
this pull request
Aug 19, 2020
Added missing INITIAL_PART to all the frames which were missed by the last change (PR #42803). Replaced the only remaining abstract with id, as it's no longer in use as an abstract.
ZhilkinSerg
reviewed
Oct 8, 2020
| def.sym = symbol; | ||
| } else { | ||
| def.symbols[ variant_id ] = symbol; | ||
| } | ||
| def.sym = jo.get_string( "symbol" )[ 0 ]; |
There was a problem hiding this comment.
Looks like this line is redundant now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
SUMMARY: Infrastructure "vehicles: simplify specifying directional variants of vehicle parts"Purpose of change
Currently vehicle parts with directional variations (like the NE and NW corner frames) are specified as separate parts, usually as copy-from of an abstract. This needlessly adds noise to the JSON and complicates the code, because deciding
frame_nwandframe_neare the same requires messing with breaking up the vpart_ids.Simplify the code and cut away a lot of JSON by adding the concept of a variant. A vpart_info with a variant just has different symbols/sprites, depending on which variant of the part is installed, but all of them have the same vpart_info.
A set of standard directional variants means that existing mods and vehicle designs are not affected, and the syntax for specifying a vehicle part is unchanged.
{ "x": 0, "y": 0, "part": "frame_cross" }still spawns a cross frame part at 0,0, even if internally it's a little different.Describe the solution
Add a new optional field to vpart_info "symbols", which is a map of direction strings to symbol ints.
Add a new optional field to vehicle_part "variant", which is a string that contains the directional variant.
Add a lot of complicated parsing to load existing save game and JSON data files into variant vehicle parts. Vehicle parts that use the 10 standard direction variants with their standard symbols can replace "sym" with
"standard_symbol": trueand have those automatically loaded; other parts will need to specify the variant string to symbol mapping as an object.vehicle_display.cpp returns the appropriate symbol for the specific variant of a vehicle part, or alternately for cata_tiles, returns the old style vehicle part ID, ie "frame_cross" for the cross variant of a frame.
The vehicle interaction menu displays names for the part variants. They're currently hardcoded and translated. I welcome suggestions for better names.
Documentation has been updated to take into account variants.
Describe alternatives you've considered
Leave things as they are, but that will get crazy as i-am-erk adds more vehicle part rotations.
Testing
Passes unit tests. I can spawn a bus and install the various variant parts on it, save and load it, and get the same bus back. I can also load existing saves without causing visual glitches.
Additional context
Will add screenshots shortly