| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| tag-gloss [2023/03/30 05:10] – [Script Calls] banerjeesw | tag-gloss [2024/03/24 05:41] (current) – [Script Calls] banerjeesw |
|---|
| ====== Commands, Notetags, & Script Calls Glossary ====== | ====== User Glossary ====== |
| |
| ===== Commands ===== | ===== Commands ===== |
| | <code>DisableCardLibrary</code> | [[plugin-core|Core Plugin]] | Map & Battle | Removes the **Card Library** option from 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>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 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. | | | <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 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. | | | <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 Plugin]] | Map & Battle | This hides the card at the specified index. | | | <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 Plugin]] | Map & Battle | This will hide all cards. | | | <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 Plugin]] | Map & Battle | This moves the card of the specified index to the specified x and y coordinates. | | | <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 ===== | ===== Notetags ===== |
| action | action |
| action | action |
| </Card Actions></code> | [[plugin-core|Core Plugin]] | Skills, Items | Used to add Actions to a Skill. Actions execute in sequential order. See:[[card-actions|Card Actions]] | | </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><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 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. | |
| ^ Script Call Syntax ^ Plugin Required ^ Project Usage ^ Description ^ | ^ 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].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].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].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].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].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].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].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(x)</code> | [[plugin-core|Core Plugin]] | Skill, Item, Troop Event, Common Event | Shuffles the user's Deck. | | | <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].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].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" | |
| 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. | 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.5.1 of IsiahCardGameCombat) | **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) |
