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/aW1nLzE1NDg0NzcyLnBuZw==/original/5tohSk.png?nolink&690}}

**MYTH_CGC_IndependentCardVariables** is a plugin gives cards a new array of variables called Var, which can be accessed through code (for damage formulas and the like) and can also be used in place of numbers in other Card Actions.

Var can contain as many variables within it that you need. To access them in card actions, use ''Var(index)'' where ''index'' is any number. By default all variables inside Var are set to 0.

This plugin is currently Patreon Only.

**Current Version: 1.1.0**

{{ https://img.itch.zone/aW1hZ2UvMjMxNzQxNC8xMzc3NzQwNy5naWY=/347x500/TWKet7.gif?nolink }}

===== Parameters =====

| **Reset Var after battle?** | If set to ON, changes to a card's Var variables will be reset at the end of each battle. |
| **Prevent Negative Cost?** | If set to ON, subtracting a Var from a skill's cost will never result in a value below 0. |
| **Preserve Var Values on Transform?** | If set to ON, the Transform action ([[plugin-card-action-pack-2|Action Pack 2]]) will not reset Var values. |
===== Card Actions =====
|< 100% 30% >|
^  Card Action Syntax  ^ Description  ^
| <code>Var(X) set Y</code> | This sets the specified Var of this card to the value supplied in Y.\\ Replace X with the Var index\\ Replace Y with the value you wish the Var index to contain  |
| <code>Var(X) mod [+/-]Y</code> | Modifies the specified Var of this card by the value of Y. Adds or subtracts Y to/from Var. \\ Replace X with the Var index\\ Replace [+/-]Y with a positive or negative number |
| <code>Var(X) set 
    eval [formula]</code> | This sets the specified var of this card to get the value of the formula. The value is re-evaluated at the end of each Action in battle. |
| <code>All Skill [skillID] Var(X)
    set Y
All Skill [skillID] Var(X)
    mod [+/-]Y
All Skill [skillid] Var(X)
    set eval [formula]</code> | These Card Actions modify the Var of all cards belonging to that actor of the specified Skill ID. |
| <code>All Skill [skillID] Var(X)
    set Y in [zoneName]
All Skill [skillID] Var(X)
    mod [+/-]Y in [zoneName]
All Skill [skillId] Var(X)
    set eval [formula] 
    in [zoneName]</code> | These Card Actions modify the Var of all cards belonging to that actor's specific zone.\\ \\ Replace [zoneName] with "Deck", "Discard" or "Hand". |
| <code>Selected Var(X) set Y
Selected Var(X) mod [+/-]Y
Selected Var(X) set 
    eval [formula]
</code> | Requires [[plugin-card-action-pack-1|Card Action Pack 1]] plugin to use.\\ \\ These Card Actions act on all Selected cards instead of the card containing the Card Actions. |

===== Card Passives =====
^ Card Passive Syntax  ^ Description  ^
| <code>Var(X) init Y</code> | This will set the initial value of Var(X) to the number specified in Y.\\ All values initialize at 0 by default, and this overrides that behavior for this Var index of all cards belonging to this skill.\\ \\ When Var values are reset, either through the "Reset Var after battle?" plugin parameter or through functions listed below, they return to their initial values. |
| <code> Var (X) init eval [formula]</code> | This will set the initial value of Var(X) to be evaluated by the formula.\\Just like when setting a Var to a formula through Card Actions, this value will update at the end of every Action in battle, until it is overridden by another Set/Mod Card Action. |

===== Getting the Value of a Var =====

In **Card Actions** you can use: ''Var(index)'' where ''index'' is the number of the index you want.

In **Damage Formulas** you can use: ''a.cardVar(index)'' where ''index'' is the number of the index you want.

In **Skill Descriptions** you can use: ''\Var[n]'' where ''n'' is the number of the index you want.

By default, these will all return 0 if no value was found at that index of Var.

**Note**: Because If and Eval statements are technically Card Actions, you can still use ''Var(index)'' in place of code in their expressions.\\ e.g.''If Var(0) < 4'' will work as expected.
===== Modifying Card Cost =====

Use the following notetag: ''<[MP/TP/HP] cost [+/-/=] var(X)>''
    
This takes the current MP/TP/HP cost and adds/subtracts/sets equal to the variable of index X in Var. Examples:

''<MP cost + var(0)>''
This will cause the value of Var(0) of that card to be added onto the base skill cost

''<TP cost - var(1)>''
This will make the TP cost go down as Var(1) goes up.

''<HP cost = var(1)>''
This will override the base HP cost and replace it with the value of Var(1).

Note that the HP cost tag will only work if you are using plugins that support HP cost.

===== Advanced Functions =====

| <code>actor.cardVar(index)</code> | This returns the value of the Var of the currently-being-used card.\\ Useful for damage formulas.  |
| <code>actor.modSkillVar(skillId, index, value, direction)</code> | This function modifies the Var of all Cards of a given Skill ID belonging to this actor.\\ direction should be -1, 0, or 1.\\ When direction is -1, value is subtracted from the var. When direction is 1, value is added to the var.\\ When direction is 0, the var is set to the value. |
| <code>actor.resetAllCardVars()</code> | This function resets all Vars of all Cards of a given Skill ID belonging to this actor. |
| <code>card.getVar(index)</code> | If you can get access to a specific Game Card you can use this function to grab the Var from that card. |

===== Version History =====
<code>
v1.2.0
- Added Eval variants on Var Card Actions.

v1.1.3 
- Fixed bug where extra zones' cards wouldn't have their Var values changed when using All Skill Var(X) Set Card Action.
Added Preserve Var Values on Transform parameter.
Fixed bug where skill description would always reference the first Var value for all Vars.

v1.1.2 
- Small change to one function for compatibility with Core Engine v1.6.2.

v1.1.1 
- Simple View for the Card Library is now forced
- Var values are now shown on cards in the Card Library Simple View.
- Initial Var values are now shown on cards in all scenes where previously their values always shown as 0.

v1.1.0 
- Changed plugin name
- Updated for compatibility with 1.6.0
- Minor refactoring to improve compatibility with other expansion plugins.

v1.0.4 
- Fixed issue where Var(x) would be replaced incorrectly in If and Eval Card Actions, breaking their functionality.
- Fixed issue where Card Descriptions would return only the last-input Var index for every index.
 
v1.0.3 
- Fixed All Skill Card Action adding numbers like strings instead of numbers. 1 + 1 now equals 2 instead of 11.
- Init Var(x) can now supply a negative number.
 
v1.0.2 
- Init Var(x) now a Card Passive for consistency with CGC.
- Cleaned up help file for improved readability.
 
v1.0.1 
- Changed syntax for Card Actions that modify Var to be a bit more intuitive.
- Fixed Set Card Action not working properly
- Added <init> notetag and fixed reset function to use initial values.
 
v1.0.0 
- Finished plugin
</code>