The <helpsystem> object describes the help bar displayed at the bottom of the screen, listing the actions available at any moment. Every button pictogram can be replaced with your own image.
| View | Name | Element |
|---|---|---|
system, detailed, basic, menu, gameclip |
help |
The view's help bar |
This object cannot be created with extra="true".
Declare it at least in the menu view: that definition is the fallback wherever a view does not provide one.
| Property | Type | Purpose |
|---|---|---|
pos |
Pair | Object position. See common properties. |
size |
Pair | Size of the help bar. |
textColor |
Colour | Text colour. |
iconColor |
Colour | Icon colour. |
fontPath |
Path | TrueType or OpenType font to use. |
fontSize |
Float | Font size, as a fraction of screen height. |
iconUpDown |
Path | Pictogram image: D-pad up/down. |
iconLeftRight |
Path | Pictogram image: D-pad left/right. |
iconUpDownLeftRight |
Path | Pictogram image: D-pad, all four directions. |
iconA |
Path | Pictogram image: A button. |
iconB |
Path | Pictogram image: B button. |
iconX |
Path | Pictogram image: X button. |
iconY |
Path | Pictogram image: Y button. |
iconL |
Path | Pictogram image: L1 trigger. |
iconL2 |
Path | Pictogram image: L2 trigger. |
iconL2R2 |
Path | Pictogram image: L2 and R2 triggers. |
iconL3 |
Path | Pictogram image: Left stick click. |
iconL3R3 |
Path | Pictogram image: Both stick clicks. |
iconLR |
Path | Pictogram image: L1 and R1 triggers. |
iconR |
Path | Pictogram image: R1 trigger. |
iconR2 |
Path | Pictogram image: R2 trigger. |
iconR3 |
Path | Pictogram image: Right stick click. |
iconStart |
Path | Pictogram image: START button. |
iconSelect |
Path | Pictogram image: SELECT button. |
iconHotkey |
Path | Pictogram image: HOTKEY button. |
iconHkA |
Path | Pictogram image: HOTKEY + A. |
iconHkB |
Path | Pictogram image: HOTKEY + B. |
iconHkL |
Path | Pictogram image: HOTKEY + L1. |
iconHkR |
Path | Pictogram image: HOTKEY + R1. |
iconHkX |
Path | Pictogram image: HOTKEY + X. |
iconHkY |
Path | Pictogram image: HOTKEY + Y. |
iconHkLeftRight |
Path | Pictogram image: HOTKEY + left/right. |
iconJ1UpDownLeftRight |
Path | Pictogram image: Left stick, all four directions. |
iconJ1UpDown |
Path | Pictogram image: Left stick, up/down. |
iconJ1LeftRight |
Path | Pictogram image: Left stick, left/right. |
iconJ2UpDownLeftRight |
Path | Pictogram image: Right stick, all four directions. |
iconJ2UpDown |
Path | Pictogram image: Right stick, up/down. |
iconJ2LeftRight |
Path | Pictogram image: Right stick, left/right. |
<view name="menu, system, detailed">
<helpsystem name="help"
pos="0.012 0.9515"
textColor="777777FF" iconColor="777777FF"
fontPath="./art/Exo2-Regular.otf" fontSize="0.025"
iconA="./art/buttons/a.svg" iconB="./art/buttons/b.svg"
iconX="./art/buttons/x.svg" iconY="./art/buttons/y.svg"
iconStart="./art/buttons/start.svg" iconSelect="./art/buttons/select.svg" />
</view>
| Property | Default |
|---|---|
pos |
0.012 0.9515 |
textColor |
777777FF |
iconColor |
777777FF |
Keep the help bar at the same position across every view: it acts as a visual anchor, and menus reuse the position defined for the menu view.