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.
====== User Glossary ======

===== Commands =====

This table has a list of every Plugin Command from ever plugin and what syntax and input is used.

^  Command Syntax  ^  Plugin Required  ^  Event Usage  ^  Description  ^
| <code>DisableCardBattle</code> |  [[plugin-core|Core Plugin]]  |  Map Only  | Reverts the Battle System to RPG Maker Defaults. |
| <code>EnableCardBattle</code> |  [[plugin-core|Core Plugin]]  |  Map Only  | Sets the Battle System to Card Game Combat. |
| <code>EnableCardLibrary</code> |  [[plugin-core|Core Plugin]]  |  Map & Battle  | Adds the **Card Library** option to the Menu. |
| <code>DisableCardLibrary</code> |  [[plugin-core|Core Plugin]]  |  Map & Battle  | Removes the **Card Library** option from the Menu. |
| <code>OpenCardLibrary</code> |  [[plugin-core|Core Plugin]]  |  Map & Battle  | Opens the **Card Library** scene directly. This can be done from the map. |
| <code>ShowCard [ID] [x] [y] [angle] [index]</code> |  [[plugin-show-card|Show Card]]  |  Map & Battle  | Replace the brackets with their respective fields. Index works just like the Number when you Show Picture.\\ \\ If Index is omitted, it will just find a new index and create a new card.\\ \\ If angle is omitted, the angle will be 0.  |
| <code>HideCardID [ID]</code> |  [[plugin-show-card|Show Card]]  |  Map & Battle  | This un-shows the card with the specified skill ID. If two or more cards have the same ID, it will hide the most recently added card. |
| <code>HideCardIndex [index]</code> |  [[plugin-show-card|Show Card]]  |  Map & Battle  | This hides the card at the specified index. |
| <code>HideAllCards</code> |  [[plugin-show-card|Show Card]]  |  Map & Battle  | This will hide all cards. |
| <code>MoveCard [index] [x] [y]</code> |  [[plugin-show-card|Show Card]]  |  Map & Battle  | This moves the card of the specified index to the specified x and y coordinates. |

===== Notetags =====

This table has a list of every Notetag from every plugin and what syntax and input is used.

^  Notetag Syntax  ^  Plugin Required  ^  Database Usage  ^  Description  ^
| <code><Hide from card library></code> |  [[plugin-core|Core Plugin]]  |  Skills  | Makes the card not show up in the Card Library  |
| <code><Card Art: file_name></code> |  [[plugin-core|Core Plugin]]  |  Skills   | Makes the card's Card Art the file of the given name.\\ \\ Art can be found in the art directory in the plugin parameters.  |
|  <code><Card Base: file_name></code>  |  [[plugin-core|Core Plugin]]  |  Skills  | Replaces the default card Base with the file of the given name.\\ \\ Bases can be found in the base directory in the plugin parameters.  |
|  <code><willEndTurn></code>  |  [[plugin-core|Core Plugin]]  |  Skills, Items  | If you are not using YEP_InstantCast, this will cause the given skill to end the turn upon use.\\ \\ If you are using YEP_InstantCast, follow that plugin's directions instead.  |
| <code><Card Passives>
 action
 action
</Card Passives></code>  |  [[plugin-core|Core Plugin]]   |  Skills, Items  | Used to add Passives to a Skill. See:[[card-passives|Card Passives]]  |
| <code><Card Actions>
 action
 action
</Card Actions></code>  |  [[plugin-core|Core Plugin]]   |  Skills, Items  | Used to add Actions to a Skill that are performed on the User. Actions execute in sequential order. See:[[card-actions|Card Actions]]  |
| <code><Card Target Actions>
 action
 action
</Card Target Actions></code>  |  [[plugin-core|Core Plugin]]   |  Skills, Items  | Used to add Actions to a Skill that are performed on the Target. Actions execute in sequential order. See:[[card-actions|Card Actions]]  |
| <code><Card Type: type_name></code>  |  [[plugin-card-types|Card Types (Plugin)]]  |  Skills  | 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 IsiahCardGameCombat will use that specified Card Base instead of the one specified by this plugin.  |
|  <code><Add Card X></code> |  [[plugin-equip-cards|Equip Cards]]  |  Weapons, Armors, States  | When an actor equips a weapon or armor with this tag, this skill will be shuffled into their deck. When they are given a state with this tag, the skill will be added to the top of their deck.\\ \\ If an actor loses the state, or changes equipment mid-battle, the card will be removed from their deck. If it's not in their deck, it will be removed from their hand. If it's not in their deck, it will be removed from their discard pile. |
|  <code><Add Card [skill name]></code> |  [[plugin-equip-cards|Equip Cards]]  |  Weapons, Armor, States  | Works similarly to the previous notetag. Instead of skill IDs, you can add them by name. Case sensitive.  |
| <code><Card Particle: X></code>  | [[plugin-cpfx|Card Particle FX]]  |  Skills  | Spawns Particles of X ID when the Card is removed.  |
| <code><Battle Start Actions>
 action
 action
</Battle Start Actions></code> | [[plugin-turn-start|Turn Start Plus]]  |  Actor, Class, Weapons, Armors, States  | This will add Card Actions executed at the start of the first turn if the party member is that Actor, that Class, is using that equipment, or is affected by that state. |
| <code><Turn Start Actions>
 action
 action
</Turn Start Actions></code>  | [[plugin-turn-start|Turn Start Plus]]  |  Actor, Class, Weapons, Armors, States    | This will add Card Actions executed at the start of every turn after the first if the party member is that Actor, that Class, is using that equipment, or is affected by that state. |
|   |   |   |   |

===== Script Calls =====

This table has a list of every Script Call from every plugin and what syntax and input is used.

^  Script Call Syntax  ^  Plugin Required  ^  Project Usage  ^  Description  ^
| <code>[Actor].drawCards(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event | Will draw X cards from the Deck  |
| <code>[Actor].drawUntil(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Will draw cards from the Deck until there are X cards in Hand  |
| <code>[Actor].drawCardsOfSkillId(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Draws Card with Skill ID Y from Deck to Hand  |
| <code>[Actor].drawCardsOfSkillName(y)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Draw Card with Skill Name Y from Deck to Hand (e.g. "Punch")  |
| <code>[Actor].discardCards(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Will prompt to Discard X Cards from Hand |
| <code>[Actor].discardUntil(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Will prompt to Discard cards from Hand until X cards are left. If X is 0, will automatically discard all cards in Hand. |
| <code>[Actor].removeCards(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Will prompt to Remove X Cards from Hand |
| <code>[Actor].removeCardsUntil(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Will prompt to Remove Cards until X cards are left. If X is 0, will automatically remove all cards in Hand. |
| <code>[Actor].millCards(x)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Puts the top X cards from Deck into their Discard.  |
| <code>[Actor].shuffleDeck()</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Shuffles the user's Deck.  |
| <code>[Actor].addCardToZone(x, zone)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Adds Card with Skill ID X to target Zone ("hand", "deck", "discard")  |
| <code>[Actor].moveCards(x, zone1, zone2)</code>  |  [[plugin-core|Core Plugin]]  | Skill, Item, Troop Event, Common Event  | Will move X cards from one Zone to another such as "hand", "deck", "discard"  |
| <code>[Actor].cardsInZoneOfType(zone, type)</code>   |  [[plugin-card-types|Card Types (Plugin)]]  | Skill, Item, Troop Event, Common Event  | 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. |

Depending on where the Script Call is being called, the variable for [Actor] will be different based on the context. When you are using these Script Calls in Skills & Items (either as a Card Action Eval or YEP Action Sequence Eval), [Actor] can be **user** (if referring to the User) or **target** (if referring to Allies). When using these Script Calls in Troop & Common Events, you will need to grab a direct reference to the [Actor] such as **$gameParty.leader()** or **$gameParty.members()[1]** in order to make these Script Calls.

**Note**: Trying to do Card Action Script Calls on Enemies will at the best of times have no effect and other times crash the game. This is because Enemies don't use Cards or have Decks (as of v1.6.0 of MYTH_CGC_CoreEngine)