plugin-help-box-control
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin-help-box-control [2024/03/23 22:09] – banerjeesw | plugin-help-box-control [2025/07/03 23:09] (current) – [Version History] isiahgames | ||
---|---|---|---|
Line 4: | Line 4: | ||
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). | 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). | ||
- | This plugin supports the State Windows created by the Myth_StateInfoPopup | + | {{ https:// |
+ | |||
+ | This plugin supports the State Windows created by the **MYTH_StateInfoPopup** | ||
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. | 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. | + | 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.1.0** | + | **Current Version: 1.2.1** |
===== Parameters ===== | ===== Parameters ===== | ||
- | + | |< 100% 30% >| | |
- | | | + | ^ |
| **Show Help Box?** | Determines whether Help Box is shown or hidden | | | **Show Help Box?** | Determines whether Help Box is shown or hidden | | ||
- | | **Anchor X** | Anchor X of the Help Box | | + | | **XY Anchor X** | The anchor positions |
- | | **Anchor Y** | Anchor Y of the Help Box | | + | | **Width/Height** | The dimensions |
- | | **Width** | Width of the Help Box | | + | | **Window Skin** | Window Skin of the Help Box | |
- | | **Height** | Height | + | | **Wrap Text?** | Text in Help Box will be word-wrapped |
- | | **Card Align** | Automatically sets Help Box XY relative to selected Card position. If " | + | |
- | | **Use Smart Align?** | If using Card Align, this shifts Alignment | + | |
- | | **Skin** | Window Skin of the Help Box | | + | |
| **Screen Edge Buffer** | Buffer of how far to keep it from the viewport edges. If set to 0, will not clamp to viewport dimensions. | | | **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. | | | **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 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 | | | **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. | | | **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 " | ||
| **Lock X when Follow?** | If True, this will fix X of the Help Box while following so it doesn' | | **Lock X when Follow?** | If True, this will fix X of the Help Box while following so it doesn' | ||
| **Lock Y when Follow?** | If True, this will fix Y of the Help Box while following so it doesn' | | **Lock Y when Follow?** | If True, this will fix Y of the Help Box while following so it doesn' | ||
+ | | **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 | | | **Use Anchor Fallback?** | If True, if inspecting outside of the Card Hand, Help Box will fallback to Anchor X Y | | ||
- | + | ^ | |
- | | **State | + | |
| **Host State Windows?** | If using MYTH_StateInfoPopup, | | **Host State Windows?** | If using MYTH_StateInfoPopup, | ||
| **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. | | | **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. | | ||
Line 43: | Line 42: | ||
< | < | ||
+ | v1.2.2 | ||
+ | - Added Message Warning infrastructure. | ||
+ | |||
+ | 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' | ||
+ | - 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' | ||
+ | - Consolidated some params into more comprehensible categories | ||
+ | |||
**v1.1.0** | **v1.1.0** | ||
- Consolidated some functionality into the core plugin. | - Consolidated some functionality into the core plugin. | ||
Line 69: | Line 87: | ||
- Basic Functionality complete. You can move the Help Box around based on Hand Index. | - Basic Functionality complete. You can move the Help Box around based on Hand Index. | ||
</ | </ | ||
+ | |||
+ | ===== ===== |
plugin-help-box-control.1711228184.txt.gz · Last modified: 2024/03/23 22:09 by banerjeesw