Mixed Hint Panels - jxjacob/GSTHD GitHub Wiki
GSTHD DK64 Edition v0.7.0 adds support for Mixed Hint Panels, wherein multiple types of hints/note can be put into a single panel. This is in contrast to the traditional panels, where a fixed space needs to be allocated for each type of hint, even in seed where some hint types are more frequent than others, leading to wasted space. All hints in a Mixed panel are sorted based on their hint type, so WotHs and grouped with other WotHs, for example.
Used efficiently, entire pages of hints can be entered into a Mixed panel with only keyboard input, cutting down on mouse-manoeuvring between different textboxes.
Mixed Hint Panels use a text shortcut system similar to that found in the Path Goal Autofill, but is unrelated to that setting and can be used with or without it.
The keycodes (NOT case-sensitive) to use a Mixed Panel are defined by the layout loaded. For example, the default DK64 layout uses the following keycodes:
Keycode | Associated Hint/Note Type |
---|---|
W |
"Way of the Hoard" hint |
P |
"Path To..." hint |
S |
"Scouring..." hint |
O |
"Other Known Locations" notes |
B |
"Barren" hints |
Usage
All examples will use the keycodes for the default DK64 layout
- Type the keycode for the hint type you are using, followed by a space, then type whatever you would for that hint normally and hit Enter.
- ex:
w vulture race
will create a yellow WotH hint for "VULTURE RACE"
- ex:
- This convention also works with the text suggestion/autocomplete
- ex:
p ash
will create a blue Path hint for "AZTEC SHOPS" - This can further be used with the Path Goal Autofill feature
- ex:
p 68dt ssr
will create a blue Path hint for "CASTLE SURROUNDINGS" with the path goals for Keys 6/8, Diddy Phase, and Tiny Phase.
- ex:
- ex:
- If a keycode is missing or is otherwise invalid, you will hear a windows error noise and the textbox will be reset to describe the error
Adding to new layouts
TODO: properly flesh out on this explanation. if you are reading this and are confused, track JXJacob down and ask him to explain better for you
The PanelMixed
object follows a similar format to the other Hint Panels, but use the unique SubPanels
property. Effectively, any hint type defined in the SubPanels will inherit the following properties from its parent PanelMixed:
- Width
- Height
- LabelFontName
- LabelFontSize
- LabelFontStyle
- LabelHeight
SubPanels therefore contain only the data that is unique to the hint type (GossipStoneSize
, CounterSize
, etc) and the hint's cosmetics. The following properties are required for all SubPanels:
Name | Type | Description |
---|---|---|
Name |
string | Unique name for the subpanel |
Type |
string | Either WotH , Barren , or Quantity ; depending on the type of hint |
Keycode |
string | Unique name for the subpanel |
LabelColor |
color | The font color for the hint |
LabelBackColor |
color | The back panel color for the hint |
For "WotH" Types, the following properties are used (bold properties are mandatory):
- GossipStoneSize
- GossipStoneCount
- GossipStoneImageCollection
- GossipStoneSpacing
- GossipStoneBackColor
- PathGoalCount
- PathGoalImageCollection
- PathGoalSpacing
- PathCycling
- SizeMode
- isMarkable
For "Quantity" Types, the following properties are used and are mandatory:
- CounterFontSize
- CounterSpacing
- CounterSize
- SubTextBoxSize
"Barren" Types do not use any specific properties, just the 5 properties in the above table.