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

**MYTH_CGC_HelpBoxControl** is a plugin allows you to change the Help Window into a moving Tooltip that
follows the currently selected Card in Hand. You can alter the dimensions of the Help Window to suit your game's needs. You can set an Anchor Point on screen where the Help Window will go to when not moving around or being offset by another feature. You can change the alignment of the Window relative to the current Card (placing it on Top, to the Left/Right, or on the Bottom).

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

This plugin supports the State Windows created by the **MYTH_StateInfoPopup** plugin so that those Windows are nested under the Help Window. You can change the alignment of the State Windows so they appear in a different part of the card or in a new configuration that better suits your game's UI. It is recommended to have your project at a resolution of 1280 x 720 px or higher to take full advantage of these UI Elements (otherwise the screen might feel a little cramped).

If the Help Window or State Windows gets too close to the edge of the screen, you can enable the Screen Edge Buffer and Smart Alignment via plugin parameters so letting the plugin figure out how best to show all Windows within the screen.

Made to work with **MYTH_CGC_CoreEngine** and **Myth_StateInfoPopup** plugins. Place those above this plugin so that the tied in features on this plugin can work.

**Current Version: 1.2.1**

===== Parameters =====

^  **Help Box Settings**  ^^
| **Show Help Box?** | Determines whether Help Box is shown or hidden |
| **XY Anchor X** | The anchor positions of the Help Box |
| **Width/Height** | The dimensions of the Help Box |
| **Window Skin** | Window Skin of the Help Box |
| **Wrap Text?** | Text in Help Box will be word-wrapped based on Window Width. |
| **Screen Edge Buffer** | Buffer of how far to keep it from the viewport edges. If set to 0, will not clamp to viewport dimensions. |
| **Card Offset Buffer** | Buffer of how far to keep it from the Card edges. If Negative, will overlap with selected card. |
| **Font Face** | Font Face for the Help Box (has to have the same name as in fonts folder) |
| **Font Size** | Font Size of the Help Box |
^  **Follow Conditions**  ^^
| **Follow Select Card?** | Determines whether the Help Box follows the currently selected card at an offset. |
| **Card Align** | Automatically sets Help Box XY relative to selected Card position. If "Don't Use", defaults to Anchor XY instead. |
| **Lock X when Follow?** | If True, this will fix X of the Help Box while following so it doesn't offset based on index. |
| **Lock Y when Follow?** | If True, this will fix Y of the Help Box while following so it doesn't offset at an arc. |
| **Use Smart Align?** | If using Card Align, this shifts Alignment based on viewport edge (e.g. Left -> Right Align if Help Box would go over edge) |
| **Use Anchor Fallback?** | If True, if inspecting outside of the Card Hand, Help Box will fallback to Anchor X Y |
^  **State Popup Integration**  ^^
| **Host State Windows?** | If using MYTH_StateInfoPopup, this will host those Windows under the Help Box |
| **Allow Dynamic Offset?** | If ON, offsets Help Box relative to current # of State Windows. If OFF, offsets Help Box based on max # of State Windows. |
| **State Align Override** | Use this if you want make sure that the State Windows ONLY show up in one configuration (ignoring Card Align). |


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

<code>
v1.2.1
- Word wrapping now uses the Core Engine solution for multi-language support
- Top/Bottom Card Alignment now properly accounts for Hand Selected Y Offset
- Fixed bug where hiding Help Window was hiding ALL Help Windows in the game
- Converted Window Height and Width params to struct

v1.2.0
- Wordwrapping now works a lot better and doesn't cut off with escape characters
- Fixed Show Help Window plugin param not working due to some CoreEngine changes

v1.1.1 
- Fixed conflicts with Party UI A, Anchors and Card Align should work now
- Added some basic word wrapping so Descriptions don't get cut off
- Fixed bug where Help Window wouldn't close when you return to Party Command
- Consolidated some params into more comprehensible categories

**v1.1.0**
- Consolidated some functionality into the core plugin.
- Changed plugin name.
 
**v1.0.3**  
- Tested MZ Functionality and compatibility for multiple resolutions
- Added Help Box Position Align Plugin Parameter (Top, Left, Right, Bottom)
- Added Smart Align Option to change Alignment in a way to stay in viewport
- Added Card Offset Buffer to limit overlap between Windows and Cards
- Added integration for IsiahStateWindows to alter State Window placement
- Added plugin parameters for additional configuration of State Windows

**v1.0.2**
- Help Box remains when a cards are Discarded or Removed as a cost
- Help Box now repositions after mouse and gamepad selection is made
- Added viewportClamp functions to keep Help Box within screen bounds
- Can provide descriptions for Deck and Discard for Help Info Box
- Can now change the Help Box Window Skin with plugin parameters
- Added AnchorFallback if inspection goes outside Card Hand

**v1.0.1**
- Added Command Selection Overrides

**v1.0.0**
- Basic Functionality complete. You can move the Help Box around based on Hand Index.
</code>

=====  =====