Card Game Combat - Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{https://img.itch.zone/aW1nLzE1NDg2MDEwLnBuZw==/original/XoTlkw.png?nolink&690}}

**MYTH_CGC_CardTypes** is a plugin allows you to add one or more card types to each Skill.

First, define the Type using the plugin parameter. When defining a type, all parameters other than the Name affect how it's drawn on the card.

Then, use skill notetags to give a skill the Card Type you created. The spelling and capitalization must be exactly the same, so watch out for typos.

**Current Version: 1.2.4**

{{ https://img.itch.zone/aW1nLzEwNDE2NzUxLnBuZw==/original/GOsi5F.png?nolink&480 }}

===== Parameters =====
|< 100% 30% >|
^  **Card Types**  ^^
| **Name** | Name of the Card Type |
| **Draw on Card?** | If set to ON, this card type will be drawn on the card. If OFF, ignore all below parameters. |
| **Icon** | The icon index that represents the card type, if you are displaying that on the card. |
| **Card Base** | The Card Base to use for all cards of this Type. Set to nothing to ignore this feature. |
| **Show in Library?** | If set to ON, the player will be able to filter by this type in the Card Library |
| **Show in Deck Editor?** | If set to ON, will show Category Icon in Deck Stats Window. |
^  **Appearance**  ^^
| **Show Name?** | If set to ON, the name of the Card Type will be shown on all cards with that type. |
| **Name Coordinates** | The X/Y coordinates for the first Card Type Name to be drawn on the card. |
| **Number of Columns** | The number of columns of Types that will display on the Card before moving down to the next row. |
| **Row Width** | The width of each row of Types. The spacing between Types will be calculated based on this plus the Number of Columns. |
| **Row Height** | The height of each row of Types. |
| **Type Icon Size** | Icons may need to be drawn scaled-down on the card. This is the pixel width/height of icons to draw. |
^  **Library Settings**  ^^
| **All Text** | The text that represents "all types" when filtering cards by type inside the Card Library, Collection scene, etc. |
===== Notetags =====
|< 100% 30% >|
^  Notetag Syntax  ^ Description  ^
| <code><Card Type: type_name></code> | Replace "type_name" with the name of the Card Type (case sensitive) that you want this skill to have. A Skill/Card can have multiple Card Types, using multiple instances of this notetag. |
Ensure that all Types you plan to use are in the Card Types plugin parameter.
  
Any skill which contains the <Card Base: file_name> notetag from **MYTH_CGC_CoreEngine** will use that specified Card Base instead of the one specified by this plugin.

===== Actions =====
|< 100% 30% >|
^  Card Action Syntax  ^ Description  ^
| <code>Draw X Type typeName</code> | This will draw the first X cards in your deck that are of the Type typeName. |
| <code>Discard X Type typeName</code> | This will require the player to discard X cards from their hand of the Type typeName. |
| <code>Remove X Type typeName</code> | This will require the player to select X cards for removal from their hand of the Type typeName. |
| <code>Mill X Type typeName</code> | The game will move the first X cards in the player's deck of the Type typeName. |
| <code>Mill Until Type typeName</code> | This will Mill cards from the top of the deck until the card at the top is of the specified type. |
| <code>Move X Type [typename] from 
    [zoneName] to [zoneName]</code> | This is the generic Move action that accepts all zones. For example, if you wanted to move 1 Spell Card from Deck to Discard, you would use:\\ <code><Card Actions>
Move 1 Type Spell from deck to discard
</Card Actions></code> |

===== Script Calls =====
|< 100% 30% >|
^  Script Call Syntax  ^ Description  ^
| <code>{actor}.cardsInZoneOfType(zone, type)</code> | This function can be used inside damage formulas, Evals, and Require notetags. It will return the amount of cards of the given type in the given zone. An example of how to format this: \\ \\ <code><Card Passives>
Require user.cardsInZoneOfType("hand", "Fossil")
</Card Passives></code> 'zone' and 'type' are string parameters, which means they must have quotation marks around them. |
| <code>{actor}.hasCardInZone(zone, skillName)
{actor}.hasCardInZone(zone, skillId)</code> | This function can be used to quickly check if a specific Card is in a Zone (e.g. Hand or Deck). It returns true if it has found it and false if it hasn't. |
| <code>Myth.CGC.getIDsOfType(type)</code> | This function returns an array containing all the skill IDs of Cards that match the type you have provided. You can use these for Card Rewards/Booster Packs or Random Card Generation. |
| <code>MYTH.CGC.getIDsOfTypes(requiresAll, 
    type1, type2, etc)</code> | This function works much like the above function, but you can supply multiple types (as many as you want), and it will return an array containing all IDs of skills that have ALL listed types if requireAll is true, or skills that have at least ONE of the listed types if requireAll is false. |

===== Version History =====
<code>
**v1.2.4**
- Created a system that creates a generic Type if the user adds a Type to a Card that hasn't been defined in Plugin Parameters.

**v1.2.3**
- Moved Myth.Util.tryParse from CardTypes to CoreEngine, genericized it slightly.
- Added parameter to change the text for "All" in the Card Types Window.
- Added utility functions Myth.CGC.getIDsOfTypesOR and Myth.CGC.getIDsOfTypesAND.
- Fixed bug where Move X of Type Action would sometimes grab cards not of that type.
- Added Card Back parameter to Type settings to prepare for MYTH_CGC_CardArtLayers

**v1.2.2**
- Changed how Types are drawn on the card to be in line with how items are drawn on a Selectable Window, ie, in a - grid.
- Added Number of Colums, Row Width and Row Height params.
- Removed redundant parameters that are in TextFormatPlus.
- Types are now case-insensitive.
- Changes made to Library Scene continue when Card Types is present.
- New function drawRandomCardsOfType(amount, type). Might be fun.
- More getter functions for cards/zones.


**v1.2.1**
- Fixed Icon Formatting Issues and added new Plugin Parameters
- Fixed TextFormatPlus bug where wrong ResetFontSettings was being used

**v1.2.0**
- Updated for compatibility with v1.6.0
- Changed plugin name
- Increased compatibility with other expansions
- Added new Card Action: Move X Type typeName from zoneName to zoneName.
 
**v1.1.0** 
- Fixed crash on Mill Until Type Card Action

**v1.0.9**
- Fixed bug that would prevent End Turn Button from being selectable to confirm discard.
- Fixed bug where Discard/Remove X of Type Card Action would softlock if player did not have enough cards of that type.

 **v1.0.8** 
- Fixed bug where skills wouldn't show up when card battle was disabled.
 
**v1.0.7**
- Added error handling to the type struct so undefined values no longer crash MZ and deployed MV games. Now they instead supply default values and warn through the console.

**v1.0.6**
- Cleaned up the loading of the type struct, types with Show in Library set to OFF will not show up in the Card Library. Types with Show in Deck Editor? set to OFF will not show up in the Deck Editor if you are using MYTH_CGC_DeckEditorCore.

**v1.0.5**          
- Updated for compatibility with CGC v1.5.1

**v1.0.4** 
- Crash hotfix for when using a card that has a Type that is not defined in the plugin parameters. Fixed error if Type list is empty.

**v1.0.3** - Fixed crash when opening Skills scene.

**v1.0.2** - Fixed MZ Card Library crash.

**v1.0.1** - Released plugin
</code>