From a77246c5f7ac301393f3b9bb0d17d8f7a321dcc1 Mon Sep 17 00:00:00 2001 From: RickyRister Date: Tue, 16 Dec 2025 02:12:54 -0800 Subject: [PATCH] add docs --- .../models/deck_list/deck_list_model.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.h b/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.h index 2f771e9d8..6e8882084 100644 --- a/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.h +++ b/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.h @@ -309,10 +309,25 @@ public: } void setDeckList(DeckList *_deck); + /** + * @brief Creates a list consisting of the entries of the model mapped into ExactCards (with each entry looked up + * in the card database). + * If a card node has number > 1, it will be added that many times to the list. + * If an entry's card is not found in the card database, that entry will be left out of the list. + * @return An ordered list of ExactCards + */ [[nodiscard]] QList getCards() const; [[nodiscard]] QList getCardsForZone(const QString &zoneName) const; + + /** + * @brief Gets a deduplicated list of all card names that appear in the model + */ [[nodiscard]] QList getCardNames() const; + /** + * @brief Gets a list of all zone names that appear in the model + */ [[nodiscard]] QList getZones() const; + bool isCardLegalForCurrentFormat(CardInfoPtr cardInfo); bool isCardQuantityLegalForCurrentFormat(CardInfoPtr cardInfo, int quantity); void refreshCardFormatLegalities();