tag-gloss
This is an old revision of the document!
Table of Contents
Commands, Notetags, & Script Calls 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 |
|---|---|---|---|
DisableCardBattle | Core Plugin | Map Only | Reverts the Battle System to RPG Maker Defaults. |
EnableCardBattle | Core Plugin | Map Only | Sets the Battle System to Card Game Combat. |
EnableCardLibrary | Core Plugin | Map & Battle | Adds the Card Library option to the Menu. |
DisableCardLibrary | Core Plugin | Map & Battle | Removes the Card Library option from the Menu. |
OpenCardLibrary | Core Plugin | Map & Battle | Opens the Card Library scene directly. This can be done from the map. |
ShowCard [ID] [x] [y] [angle] [index] | Show Card Plugin | 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] | Show Card Plugin | 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] | Show Card Plugin | Map & Battle | This hides the card at the specified index. |
HideAllCards | Show Card Plugin | Map & Battle | This will hide all cards. |
MoveCard [index] [x] [y] | Show Card Plugin | 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 |
|---|---|---|---|
<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. 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 |
|---|---|---|---|
user.drawCards(x) | Core Plugin | Will draw X cards from the Deck | |
user.drawUntil(x) | Core Plugin | Will draw cards from the Deck until there are X cards in Hand | |
user.drawCardsOfSkillId(x) | Core Plugin | Draws Card with Skill ID Y from Deck to Hand | |
user.drawCardsOfSkillName(y) | Core Plugin | Draw Card with Skill Name Y from Deck to Hand (e.g. “Punch”) | |
user.discardCards(x) | Core Plugin | Will prompt to Discard X Cards from Hand | |
user.discardUntil(x) | Core Plugin | Will prompt to Discard cards from Hand until X cards are left. If X is 0, will automatically discard all cards in Hand. | |
user.removeCards(x) | Core Plugin | Will prompt to Remove X Cards from Hand | |
user.removeCardsUntil(x) | Core Plugin | Will prompt to Remove Cards until X cards are left. If X is 0, will automatically remove all cards in Hand. | |
user.millCards(x) | Core Plugin | Puts the top X cards from Deck into their Discard. | |
user.shuffleDeck(x) | Core Plugin | Shuffles the user's Deck. | |
user.addCardToZone(x, zone) | Core Plugin | Adds Card with Skill ID X to target Zone (“hand”, “deck”, “discard”) | |
user.moveCards(x, zone1, zone2) | Core Plugin | Will move X cards from one Zone to another such as “hand”, “deck”, “discard” | |
user.cardsInZoneOfType(zone, type) | Card Types (Plugin) | 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. |
tag-gloss.1680145242.txt.gz · Last modified: 2023/03/30 05:00 by banerjeesw