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 =====

==== Core Engine ====
The list of Plugin Commands available in the [[plugin-core|Core Plugin]] are as follows:

{{page>plugin-core#plugin_commands}}

==== Card Collection ====
The list of Plugin Commands available in the [[plugin-card-collection|Card Collection]] are as follows:

{{page>plugin-card-collection#plugin_commands}}

==== Deck Editor ====
The list of Plugin Commands available in the [[plugin-deck-edit|Deck Editor]] are as follows:

{{page>plugin-deck-edit#plugin_commands}}

==== Card Shop ====
The list of Plugin Commands available in the [[plugin-card-shop|Card Shop]] are as follows:

{{page>plugin-card-shop#plugin_commands}}


==== Card Summons====
The list of Plugin Commands available in the [[plugin-card-summons|Card Summons]] are as follows:

{{page>plugin-card-summons#plugin_commands}}
===== Notetags =====

This section contains all Notetags other than [[card-actions|Card Actions]] and [[card-passives|Card Passives]].

==== Core Engine ====
The list of Notetags available in the [[plugin-core|Core Plugin]] are as follows:

{{page>plugin-core#notetags}}

==== Card Types ====
The list of Notetags available in [[plugin-card-types|Card Types]] are as follows:

{{page>plugin-card-types#notetags}}

==== Equip Cards ====
The list of Notetags available in [[plugin-equip-cards|Equip Cards]] are as follows:

{{page>plugin-equip-cards#notetags}}

==== Block Generate ====
The list of Notetags available in [[plugin-block-generate|Block Generate]] are as follows:

{{page>plugin-block-generate#notetags}}

==== Card Collection ====
The list of Notetags available in [[plugin-card-collection|Card Collection]] are as follows:

{{page>plugin-card-collection#notetags}}

==== Deck Editor ====
The list of Notetags available in [[plugin-deck-edit|Deck Editor]] are as follows:

{{page>plugin-deck-edit#notetags}}

==== Card Shop ====
The list of Notetags available in [[plugin-card-shop|Card Shop]] are as follows:

{{page>plugin-card-shop#notetags}}

==== Card Summons ====
The list of Notetags available in [[plugin-card-summons|Card Summons]] are as follows:

This section is temporarily blank.

==== Card Particle FX ====
The list of Notetags available in [[plugin-cpfx|Card Particle FX]] are as follows:

{{page>plugin-cpfx#notetags}}

==== Turn Start Plus ====
The list of Notetags available in [[plugin-turn-start|Turn Start Plus]] are as follows:

{{page>plugin-turn-start#notetags}}

==== Card Art Layers ====
The list of Notetags available in [[plugin-card-layers|Card Art Layers]] are as follows:

{{page>plugin-card-layers#notetags}}

===== 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)