-
Notifications
You must be signed in to change notification settings - Fork 0
IFormat
Eronan edited this page Sep 15, 2022
·
2 revisions
IFormat is an interface that defines the deckbuilding a information for a Game's Format.
Type: Interface
Namespace: IGamePlugInBase
Assembly: IGamePlugInBase.dll
| Property Name | Type | Description |
|---|---|---|
| Name | string | A Short Name for your Format. This is used for saving Deck Files. |
| Long Name | string | A Long Name for your Format. This is displayed to the user via the Load Plug-In. |
| Icon | byte[] | The Image that shows up when the user is selecting a Format to Open. |
| Description | string | A description of the Format that is displayed in the Load Plug-In window. Basic differences should be explained here. |
| Decks | IEnumerable<IDeck> | A list of Decks that a Format's Decklist should include. (e.g. Main Deck/Extra Deck/Side Deck from Yu-Gi-Oh!, or Main Deck/Side Deck from Magic) |
| DeckBuilderService | IDeckBuilderService | An interface that defines the functions for a Format's Deckbuilding Rules. If you don't wish to add any rules for the Plug-In, it can be ignored. However, this will allow the creation of illegal decks when ignored. |
- Your Plug-In should contain 10 Formats at maximum. For complicated deck-building rules that are based around a choice chosen before building a deck (e.g. Cardfight Vanguard's Clan Fight Rules), it can be done by being creative with the DeckBuilderService (e.g. A Binary Value is used to check whether all cards in a Deck match that value).
- You must have at least 1 Deck defined in the Format otherwise, it will be considered a Format that hasn't been implemented.
- Image Icons can be defined as Resources for the DLL or loaded from a Relative Path but must be loaded into a Byte Array. Having it defined in Resources is recommended as your user will need to download less files overall.