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/aW1nLzE1NDg2Mzc5LnBuZw==/original/H3Igs2.png?nolink&690}}

**MYTH_CGC_ActionPack1** is a plugin adds several new Card Actions (CAs) which involve the Card Selection Window.

**Current Version: 1.2.0**

[[plugin-card-action-pack-1#selection_card_actions|Selection CAs]] open the Selection Window and have the player select cards.

[[plugin-card-action-pack-1#movement_card_actions|Movement CAs]] perform an action involving the cards selected in the Selection CA.

[[plugin-card-action-pack-1#clear_card_actions|Clear CAs]] clears the list of selected cards so future Movement CAs do not use them.

{{ https://img.itch.zone/aW1nLzE1NTA3MTA5LmdpZg==/original/vJHijN.gif?nolink }}

These Card Actions work together in a group as part of 1 of 3 stages:
  - Selection
  - Movement
  - Clear

A Selection CA must be called before a Movement CA can execute, and a Clear CA cleans up all internal variables to prepare for the next set of Card Actions.

Example:
  <Card Actions>
    Select 2 from deck
    Move selected to discard
    Clear selected
  </Card Actions>
  
This makes the player move 2 cards of their choice from their deck to their discard.

===== Selection Card Actions =====

|  <code>Select X from zoneName</code>  |Replace 'X' with a number or game variable, and replace 'zoneName' with 'deck', 'discard' or 'hand'. This opens the Card Selection Window and makes the player choose X cards from the specified zone.  |
|  <code>Select X of Y from zoneName location</code>  |Replace 'X' with a number, 'Y' with another number,'zoneName' with a zone, and a 'location'.\\ \\ This makes the player choose X cards from a selection of Y cards from the specified zone. Replace 'zoneName' with 'deck', 'discard' or 'hand'. Replace 'location' with 'Top', 'Bottom', 'Random'. If 'Top', The pool of cards will be grabbed from the top Y cards. If 'Bottom', the bottom. If 'random', cards will be grabbed randomly from the zone.  |
|  <code>Select X from skills Y, Z, A, B</code>  |Replace X, Y, Z, etc with numbers.This makes the player choose X cards from a list of Skill IDs. The list of IDs can be any size.  |
|  <code>Select All from zoneName</code>  |Selects all Cards in the specified zone.  |
|  <code>Select X Type typeName from zoneName</code>  |Requires CardTypes. Replace X with a number, typeName with the name of a Card Type, and zoneName with a zone. This makes the player choose X cards from the specified zone filtered to only include the specified Card Type.  |
|  <code>Select X of Y Type typename from zoneName location</code>  |Requires CardTypes. This makes the player choose X cards from the specified zone, filtered to only include the specified Card Type, with a pool size of Y grabbed from the top/bottom or grabbed randomly from the zone.  |
| <code>Select Any from zoneName</code> | Allows players to choose any number of cards from a specified zone in a selection, including 0. They can hit cancel to finish their selection. |
| <code>Select Upper Text: string</code> | Changes the Upper Text of the Selection Window to the string provided. |
| <code>Select Lower Text: string</code> | Changes the Lower Text of the Selection Window to the string provided. \\ Use the following text codes inside the strings of either of these Card Actions: \\ %actor - Actor Name \\ %selectNum - Number of cards currently selected \\ %unselectNum - Number of cards currently not selected \\ %selectReq - Number of cards required to be selected \\ %zone - Zone cards are being selected from (if any) |

Note that each Selection CA adds to the list of selected cards, rather than overwriting it.

===== Movement Card Actions =====

Once the player has selected cards, these Card Actions will do something with them.

|  <code>Move Selected to zoneName</code>  | Replace 'zoneName' with a zone. This will move the selected cards from their previous zone to the specified zone.  | 
| <code>Move Unselected to zoneName</code> | This will move the cards that WEREN'T selected cards from their previous zone to the specified zone. |
|  <code>Remove Selected</code>  | This will remove the selected cards from play.  |
|  <code>Remove Unselected</code>  | This will remove the cards that WEREN'T selected from play.  |
|  <code>Add Selected to zoneName</code>  | Replace 'zoneName' with a zone. This will add a copy of each selected card to the specified zone. \\ \\ Note that the Add action is the only Movement Card Action that works when using the Card Action "Select from Skills" because it's the only one that does not require a zone of origin.  |
|  <code>Add Unselected to zoneName</code>  | Replace 'zoneName' with a zone. This will add a copy of each card that WASN'T selected to the specified zone. \\ \\ Note that the Add action is the only Movement Card Action that works when using the Card Action "Select from Skills" because it's the only one that does not require a zone of origin.  |

===== Clear Card Actions =====

Each Selection Card Action adds to the list of selected cards, and that list will not be cleared until you call one of the following:

  Clear Selected
  Clear Selection

This means that, until you call Clear Selected/Selection, you can perform multiple Selection CAs and one Movement CA which will act on all of them, or call multiple movement CAs with only one selected card.

====== Version History ======

<code>
**v1.2.0**
- Added Select Any from zoneName Action
- Added Select All Type typeName from zoneName
- Added "unselected" variant of Movement Card Actions
- Moved highlight sprite loading to img/CGC/highlights
- Exposed text components to plugin parameters.

**v1.1.1**
- Fixed crash if selecting from a pool of cards that has a length of 0.

**v1.1.0** 
- Added Select All Card Action
- Selection text will no longer appear while browsing cards normally.
- Updated for combatibility with CGC core v1.6.0 and Card Summons.
- Minor refactoring to improve Card Actions reading variables
- Renamed plugin
- Added option to not display text in the Card Selection Window
- Fixed crash from selecting cards too fast.

**v1.0.0**
- Released plugin
</code>