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.
{{https://img.itch.zone/aW1nLzE1NDg2Mzc2LnBuZw==/original/baUVZY.png?nolink&690}}

**MYTH_BlockGenerate** is a utility plugin which simulates Block in the style of deckbuilders like Slay the Spire. Block is a defensive resource that can be accumulated by playing cards or having certain items equipped. When damage is dealt to the Actor, Block is deducted first before Health.

{{ https://img.itch.zone/aW1nLzE1NTA3MDczLnBuZw==/original/riaZmg.png?nolink&640 }}

This plugin has you select one State as the Block State which is automatically applied to an Actor or Enemy when they have any amount of Block. It includes Notetags and Script Calls (see below) for determining how this Block is gained and lost from different sources.

**Current Version: 1.0.0**

===== Parameters =====

| **Block State ID** | Set this to the ID of the Block State in your Database. |
| **Default Initial Block** | Default Initial Block value for all Battlers at Battle Start. |
| **Default Max Block** | Default Max Block value for all Battlers at Battle Start. Set to -1 to have no Max. |
| **Position Offset** | X and Y Offsets for the Block Icon relative to its base position at the Actor. |

===== Notetags =====

^  Notetag Syntax  ^  Database Usage  ^  Description  ^
| <code><Init Block: X></code> | Actors, Enemies | Sets initial Block value this Actor/Enemy will have at the start of a battle. |
| <code><Max Block: X></code> | Actors, Enemies | Sets maximum Block value this Actor/Enemy can have at any one time. |
| <code><Ignore Block></code> | Skills, Items | Damage Formula of these Skills/Items will ignore target's Block and deal their damage directly to HP instead. Useful for "piercing" type Skills. |
| <code><Mod Init Block: +x></code> | Weapons, Armors | Modifies an Actor's Initial Block amount by adding a positive/negative number. Can stack from multiple sources (like different pieces of equipment). |
| <code><Mod Max Block: +x></code> | Weapons, Armors | Modifies an Actor's Max Block amount by adding a positive/negative number. Can stack from multiple sources (like different pieces of equipment). |
| <code><Block Change: +X></code> | States | Determines how much an Actor with the State will gain/lose Block at the end of their turn (during the Regenerate Step). Can stack from multiple sources. If there is both Block Gain and Block Loss from multiple States, the values are summed together and applied as a single instance of generation e.g. if State A gains 20 BLOCK each turn and State B loses 40 Block each turn, then an Actor with both State A and B loses 20 Block (+20 - 40 = -20) each turn |
| <code><Negate Block></code> | States | When a State with this Notetag is applied to an actor, they will lose all Block and be unable to gain Block until it elapses or is removed. |

===== Script Calls =====

| <code>{battler}.getBlock()</code> | Returns the Battler's current Block value. |
| <code>{battler}.setBlock(value, show)</code> | Sets the Battler's Block to value. Show can be true/false depending on whether you want a Damage Popup and Battle Log message to show the change. |
| <code>{battler}.addBlock(value, show)</code> | Adds to the Battler's Block. Value can be either positive or negative. If it goes over the Battler's Max or under 0, the value is automatically clamped. Show can be true/false depending on whether you want a Damage Popup and Battle Log message to show the change. |
| <code>{battler}.clearBlock(show)</code> | Clears the Battler's Block setting it to 0 and removing the Block State. |

===== Version History =====
<code>
**v1.0.0** 
- Base Functionality complete! Will probably come back around and do some minor edits 
once I am done testing this with the CGC Demo Project.
</code>