Decouple CardPileUI from JSON file loading #5
Conversation
This file contains hidden or 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
CardDB is now a generic loading/lookup mechanism with two built-in implementations: * NullCardDB, which doesn't do any loading or lookup. It simply acts as a pass-through for cards supplied by external means * JSONFileCardDB, which implements loading/lookup compatible with the previous interface. It can also be subclassed to implemented any required custom transformation during loading Setting json_card_database_path and json_card_collection_path is now deprecated, but still supported for backwards compatibility. New code should use card_database and card_collection directly instead, and pick a CardDB implementation to use.
Unfortunately it's not possible to simply use custom iterables to mimic a plain Array, because of a bug in the iteration protocol implementation currently present in 4.2 that's not fixed before 4.3, which would require calling a function anyway (godotengine/godot#74686)
Author
|
Marking it as a draft for now, since I haven't fully integrated |
mathrick
force-pushed
the
decouple-json-card-db
branch
from
fd8cf2c to
6eaff8d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This splits the card database loading into a separate component (
CardDB) which can be implemented however the user wishes, withJSONFileCardDBbeing a built-in option provided.CardCollectionhas also undergone a similar treatment (unfortunately, in Godot 4.2 it's not possible to provide a drop-in replacement object which can be iterated like a simple array whilst also allowing custom logic, because of godotengine/godot#74686). They are coupled toCardPileUIthrough a very simple protocol which imposes a minimal amount of requirements on the user code.For backwards compatibility, JSON loading will still happen as a fallback if no
card_databaseorcard_collectionhas been provided, so existing code will continue to work unchanged. This has been tested using the examples: example 1 (ie. main scene) has been ported to useJSONFileCardDBexplicitly, whereas example 2 uses the old deprecated*_file_pathproperties. Both work without issues.All of the changes have been fully documented in the
README.Fixes #4.