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.
====== Battle Screen ======
This page covers the new UI Elements that are added to the Battle Screen by [[plugin-core|IsiahCardGameCombat]].
{{https://cdn.discordapp.com/attachments/235557488794009600/1090877648793772122/image.png?640}}

===== Card Hand =====
This is the fan of Cards in the Hand of the active Actor.

{{https://cdn.discordapp.com/attachments/235557488794009600/1090882450122616832/image.png?300}}
{{https://cdn.discordapp.com/attachments/235557488794009600/1090878262055546920/image.png?300}}

| **Hand Y Coordinate** | The y coordinate for the card hand to be in battle. Generally recommend the bottom of the screen. |
| **Hand Center X Coord** | The x coordinate of the *center* of the hand. Default is 408, half RM's default window width. |
| **Selected Card Y Offset** | The number of pixels the currently selected card will raise above the rest of the hand |
| **Discarding Card Y Offset** | The number of pixels a card will be raised if it is chosen to be discarded. |
| **Max Hand Width** | The max horizontal space the hand can take up. |
| **Min Card Separation W** | The minimum space in pixels between cards until the max width would otherwise be reached. |
| **Card Rotation Multiplier** | Cards will rotate the farther they are from the hand. This adds a multiplier to that amount to increase or decrease that rotation. |
| **Card Height Multiplier** | Card height changes depending on their distance from the center of the hand. This adds a multiplier to that amount to increase or decrease that height. |
|  |  |

===== Deck Icon =====

This is the icon that represents the player’s deck. It contains a number that represents how many cards are in the deck.

{{https://cdn.discordapp.com/attachments/235557488794009600/1090882780898009108/image.png?200}}
{{https://cdn.discordapp.com/attachments/235557488794009600/1090878470185308180/image.png?300}}

| **Deck Image** | An image file to represent the deck. It can be a card back, or something more abstract. |
| **Deck X coordinate**\\ **Deck Y coordinate** | These represent the coordinates on the screen the deck image will appear. |
| **Deck card scale**\\ **Deck card rotation** | If the Deck Image is smaller than the card images, and appears to be at an angle, as in the above screenshot, then when cards are drawn they should be scaled down and angled as they appear below the Deck Image, then scale up and re-orient themselves as they move into the hand.\\ The effect is that cards appear the same size as the Deck Image, then grow into their full size. It feels more like cards are being drawn from the deck that way.\\ Deck Card Scale is a number between 0 and 1 if the card should be smaller than its normal size, and between 1 and 4 if it should be bigger.\\ \\ Deck Card Rotation is measured in degrees between -360 and 360. |
| **Deck Amount Number Font Size** | The font size for the number representing how many cards are in the deck. |
| **Deck Number X Coord**\\ **Deck Number Y Coord** | The coordinates for the Deck Amount Number. This number is right-aligned, so 0, 0 represents the top right of the Deck Image. |
|  |  |

===== Discard Pile =====

This is very similar to the Deck Icon in that it represents the Discard Pile - the key difference being that it can be represented by the most recently discarded card instead of an icon

{{https://cdn.discordapp.com/attachments/235557488794009600/1090883305836138496/image.png?230}}
{{https://cdn.discordapp.com/attachments/235557488794009600/1090878763400691712/image.png?300}}

| **Discard Image** | This image represents the Discard Pile similar to how the Deck Image represents the deck. Even if the image is not visible, it defines the size of the discard pile. |
| **Show Discard Image?** | This parameter determines whether the Discard Image will be shown or it will instead show the most recently discarded card. |
| **Discard X coordinate**\\ **Discard Y coordinate** | These represent the coordinates on the screen the discard pile will appear. |
| **Discard card scale**\\ **Discard card rotation** | Just like the Deck card scale and rotation parameters, these determine how the cards themselves will be sized/rotated as they travel between the hand and this pile.  |
| **Discard Amount Number Font Size** | The font size for the number representing how many cards are in the discard pile. |
| **Discard Number X Coord**\\ **Discard Number Y Coord** | The coordinates for the Discard Amount Number. This number is right-aligned, so 0, 0 represents the top right of the Discard Image. |
|  |  |

===== End Turn Button =====

This is a feature under the Extra Battle Buttons category of parameters. When selected, it will execute a skill. It is intended that this skill will end the player’s turn.

While the End Turn Button is enabled, it will become the Discard button when the player needs to discard cards. The player will select cards to discard, and then select the Discard button to confirm their selection. If the End Turn Button is disabled, the cards are automatically discarded as soon as the final necessary card is selected, and there is no confirm button.

{{https://cdn.discordapp.com/attachments/235557488794009600/1090888128283291669/image.png?180}}
{{https://cdn.discordapp.com/attachments/235557488794009600/1090879033979453560/image.png?380}}

| **End Turn Skill #**  | This is the Skill ID of the skill that is executed when the player selects the End Turn Button. As long as the End Turn Button parameter is set to ON, the player will always have access to this skill during their turn.\\ \\ In the demo project that came with the plugin, for example, the End Turn skill is one of a few skills that does not use **YEP_InstantCast**, and it has no other effects but to take up a turn.\\ \\ As this is a skill, it can have Card Actions attached to it. |
| **End Turn Image** | The image that is used for the End Turn Button. |
| **End Turn Disabled Image** | The image that is used for the button while it cannot be pressed. |
| **End Turn Highlighted Image** | The image that is overlayed on top of the End Turn Button while it is the currently highlighted option. |
| **End Turn Discard Image** | The image that is used for the button when it becomes the Discard button. |
| **Discard Disabled Image** | The image that is used when the Discard button cannot be pressed - when not enough cards have been selected for discard. |
| **X coordinate**\\ **Y coordinate** | The coordinates on screen for the End Turn button. |
| **End Turn Use Condition** | (Advanced use) A code expression that must evaluate to true for the End Turn Button to be usable. |
|  |  |

===== Item Button =====

This is a feature under the Extra Battle Buttons category of parameters. Similar to the End Turn Button, the Item Button is a highlightable option when scrolling through your cards. When selected, it will open the item menu.

{{https://cdn.discordapp.com/attachments/235557488794009600/1090889576001835059/image.png?150}}
{{https://cdn.discordapp.com/attachments/235557488794009600/1090888350996635658/image.png?400}}

| **Item Button Image** | The image that is used for the item menu button. |
| **Item Button Disabled Image** | The image that is used for the item menu button when it cannot be pressed. |
| **Item Button Highlighted Image** | The image that is overlayed on the item menu button when it is highlighted. |
| **X coordinate**\\ **Y coordinate** | The x coordinate for the item button to be on the screen. The y coordinate for the item button to be on the screen. You should keep it to the left of the hand. |
| **Item Button Description** | The text that appears on the help window when the item button is highlighted. If the Show Help Window parameter is set to OFF, you can ignore this. |
| **Item Button Use Condition** | (Advanced use) A code expression that must evaluate to true for the Item Button to be usable. |

===== Other Windows =====

This plugin changes the UI of battle in a few ways. Some of them are toggleable in the plugin parameters.

**Change Battle Windows** - Set to ON by default, if it’s switched to OFF all other plugin parameters in this section can be ignored except for Show Help Window.

The Battle Status Window is set to show only 1 row while Change Battle Windows is ON. This is because, in default RMMV, there isn’t quite enough room for it to show 4 actors and also display cards, and there isn’t much need for it as most games will only need 1 actor in play.

However, Change Battle Windows can be set to OFF to undo all UI changes aside from the Help Window, in case the UI is being changed by another plugin instead.

**Show Help Window** - If this is set to OFF, the Help Window will not appear for skills/cards. This does not disable the Help Window entirely, only for Skills. This can be useful to save screen real-estate if Skill descriptions are already on the cards.
**
Skip Actor Command Menu** - If this is set to ON, the Actor Command Window will not open. Instead, the player will jump right to card selection on their turn. The Item menu can still be made available through the Item Button.

**Status Window At Top** - If set to ON, the Battle Status Window will appear at the top of the screen instead of the bottom. When the Help Window is visible, it will move to directly underneath the Help Window.