This is an old revision of the document!

User Glossary

Commands

Core Engine

The list of Plugin Commands available in the Core Plugin are as follows:

Command Syntax	Event Usage	Description
DisableCardBattle	Map Only	Reverts the Battle System to RPG Maker Defaults.
EnableCardBattle	Map Only	Sets the Battle System to Card Game Combat.
EnableCardLibrary	Map & Battle	Adds the Card Library option to the Menu.
DisableCardLibrary	Map & Battle	Removes the Card Library option from the Menu.
OpenCardLibrary	Map & Battle	Opens the Card Library scene directly. This can be done from the map.
ShowCard [ID] [x] [y] [angle] [index]	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.
HideCardID [ID]	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.
HideCardIndex [index]	Map & Battle	This hides the card at the specified index.
HideAllCards	Map & Battle	This will hide all cards.
MoveCard [index] [x] [y]	Map & Battle	This moves the card of the specified index to the specified x and y coordinates.

Card Collection

The list of Plugin Commands available in the Card Collection are as follows:

Command Syntax	Event Usage	Description
OpenCardCollection	Map Only	Opens the Card Collection scene directly. This can be done from the map.

Deck Editor

The list of Plugin Commands available in the Deck Editor are as follows:

Command Syntax	Event Usage	Description
IncreaseDP [ActorID] [Amount]	Map Only	Will add the specified amount to the actor's max DP, like raising a stat.
OpenDeckEditor	Map Only	Will open the Deck Editor Scene during an Event
EquipDeck [ActorID] [DeckName]	Map Only	Equips Actor with matching ID with a Decklist you specify. Actor needs to be in the party. Decklist needs to match the name given. Example: “EquipDeck 1 HeroStarter” will equip the Actor at ID 1 with the Decklist called “HeroStarter” if it is available.
AddCardToDeck [ActorID] [DeckName] [SkillID] [addToLibraryToo]	Map Only	Adds the supplied Card to the supplied actor's deck, if such a deck exits. In place of a deck name you can use “%current” for the deck the actor currently has equipped. AddToLibraryToo - (true/false) determines if the Card is also added to the actor's (or party's) library. It is recommended to keep this as true to prevent making a deck illegal.
RemoveCardFromDeck [ActorID] [DeckName] [SkillID] [RemoveFromLibraryToo]	Map Only	Removes the specified Card from the actor's deck, if the card is present. In place of a deck name you can use “%current” for the deck the actor currently has equipped. RemoveFromLibraryToo - (true/false) determines if the Card is also removed from the actor's (or party's) library. It is recommended to keep this as false to prevent making other decks illegal.

Card Shop

The list of Plugin Commands available in the Card Shop are as follows:

Command Syntax	Event Usage	Description
OpenCardShop	Map Event	Functions just as this.cardShopProcessing() to open Card Shop Scene in Event
ResetCardShop [ID]	Map Event	Functions just as this.resetCardShopInventory() to restock shop's original nventory and reset its Remove costs. If [EventID] is not specified will default to resetting the shop for the current Event.

Card Summons

The list of Plugin Commands available in the Card Summons are as follows:

Command Syntax	Event Usage	Description
DisableCardField	Map Only	Disables the Summons Field and returns to normal CGC battle.
EnableCardField	Map Only	Enables the Summons Field if it's been disabled.

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
<Hide from card library>	Core Plugin	Skills	Makes the card not show up in the Card Library
<Card Art: file_name>	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.
<Card Base: file_name>	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.
<willEndTurn>	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.
<Card Passives> action action </Card Passives>	Core Plugin	Skills, Items	Used to add Passives to a Skill. See:Card Passives
<Card Actions> action action </Card Actions>	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 Target Actions> action action </Card Target Actions>	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 Type: type_name>	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.
<Add Card X>	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.
<Add Card [skill name]>	Equip Cards	Weapons, Armor, States	Works similarly to the previous notetag. Instead of skill IDs, you can add them by name. Case sensitive.
<Card Particle: X>	Card Particle FX	Skills	Spawns Particles of X ID when the Card is removed.
<Battle Start Actions> action action </Battle Start Actions>	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.
<Turn Start Actions> action action </Turn Start Actions>	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
[Actor].drawCards(x)	Core Plugin	Skill, Item, Troop Event, Common Event	Will draw X cards from the Deck
[Actor].drawUntil(x)	Core Plugin	Skill, Item, Troop Event, Common Event	Will draw cards from the Deck until there are X cards in Hand
[Actor].drawCardsOfSkillId(x)	Core Plugin	Skill, Item, Troop Event, Common Event	Draws Card with Skill ID Y from Deck to Hand
[Actor].drawCardsOfSkillName(y)	Core Plugin	Skill, Item, Troop Event, Common Event	Draw Card with Skill Name Y from Deck to Hand (e.g. “Punch”)
[Actor].discardCards(x)	Core Plugin	Skill, Item, Troop Event, Common Event	Will prompt to Discard X Cards from Hand
[Actor].discardUntil(x)	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.
[Actor].removeCards(x)	Core Plugin	Skill, Item, Troop Event, Common Event	Will prompt to Remove X Cards from Hand
[Actor].removeCardsUntil(x)	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.
[Actor].millCards(x)	Core Plugin	Skill, Item, Troop Event, Common Event	Puts the top X cards from Deck into their Discard.
[Actor].shuffleDeck()	Core Plugin	Skill, Item, Troop Event, Common Event	Shuffles the user's Deck.
[Actor].addCardToZone(x, zone)	Core Plugin	Skill, Item, Troop Event, Common Event	Adds Card with Skill ID X to target Zone (“hand”, “deck”, “discard”)
[Actor].moveCards(x, zone1, zone2)	Core Plugin	Skill, Item, Troop Event, Common Event	Will move X cards from one Zone to another such as “hand”, “deck”, “discard”
[Actor].cardsInZoneOfType(zone, type)	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)

Card Game Combat - Documentation

Table of Contents