Skip to content
Eronan edited this page Sep 15, 2022 · 4 revisions

IDeck is an interface that defines one of the decks that makes up an overall decklist for a Game Format. (e.g. Main Deck, Side Deck, Extra Deck)

Properties

Property Name Type Description
Name string A Short Name for your Deck. This is used for saving Deck Files.
Label string The text that shows up on the Deckbuilding Window.
ExpectedDeckSize int Not currently implemented, but is meant to determine how large a Deck will be normally. (e.g. 49-card Deck, 50-card Deck)

Methods

IDeck.ValidateAdd(DeckBuilderCard, IEnumerable<DeckBuilderCard>);

Definition

Returns a Boolean value indicating whether a card can be added to the existing Deck Instance based on the cards that belong to the Deck Instance.

public IGamePluginBase.IDeck ValidateAdd(DeckBuilderCard card, IEnumerable<DeckBuildercard> deck

Parameters

card DeckBuilderCard

The card that is being confirmed as to whether it can be added to the current Deck.

deck IEnumerable<DeckBuilderCard>

A list of cards in the Deck Instance retrieved from the Deck Builder Application.

Returns

Boolean

Returns TRUE if the card can be added to the Deck.

General Standards

The Method should only determine information based on the Deck itself, it should not validate any Card Restrictions related to the whole decklist as it is not possible to. Examples of what can be validated is the size of the Deck itself (e.g. only 50 cards, not having any cards, having specific cards).

IDeck.ValidateDeck(IEnumerable<DeckBuilderCard>);

Definition

Provides a list of Error Messages with the existing Decklist for this Deck Instance.

public IGamePluginBase.IDeck ValidateDeck(IEnumerable<DeckBuildercard> deck

Parameters

deck IEnumerable<DeckBuilderCard>

A list of cards in the Deck Instance retrieved from the Deck Builder Application.

Returns

String[]

An array of Error Messages detailing the errors existing in the current Deck.

General Standards

The Method should only determine information based on the Deck itself, it should not validate any Card Restrictions related to the whole decklist as it is not possible to. Examples of what can be validated is the size of the Deck itself (e.g. only 50 cards, not having any cards, having specific cards).

Clone this wiki locally