XML:HPge: Difference between revisions
Jump to navigation
Jump to search
m (AE7 path) |
m (copy edit) |
||
Line 1: | Line 1: | ||
{{XML_File_Header | type=HPge | prev=FILM | next=IGHH | name=Help Page }} | {{XML_File_Header | type=HPge | prev=FILM | next=IGHH | name=Help Page }} | ||
== | ==General information== | ||
* The | * The XML on this page is compatible with OniSplit '''v0.9.61.0'''. | ||
* HPge is '''global''' | * HPge is '''global''' (it can be found in AE/AEInstaller/vanilla/level0_Final.dat). | ||
* There's only one HPge. | * There's only one HPge in Oni. | ||
* The | * The visual guides for the left and right HUD elements that appear at the start of Chapter 1 come from '''IGHH'''hud_help_info. HPge and [[XML:IGHH|IGHH]] get displayed at the same time. | ||
==File structure== | |||
[[Image:HPge.png|thumb|200px|right|Help page plus IGHH illustration]] | |||
[[Image:HPge.png|thumb|200px|right| | |||
HPge | HPge | ||
Line 21: | Line 20: | ||
+-- IGSt | +-- IGSt | ||
==XML tags== | |||
===HPge instance=== | |||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width=100px | XML tag | !width=100px | XML tag | ||
!width=100px| | !width=100px | Content type | ||
! | ! Description | ||
|- | |- | ||
|valign=top| <HPge id="..."> | |valign=top| <HPge id="..."> | ||
|valign=top| integer | |valign=top| integer | ||
| instance | | instance ID, should be 0 | ||
|- | |- | ||
| <Page> | | <Page> | ||
| link | | link | ||
| # + instance | | # + instance ID, links to IGPG | ||
|} | |} | ||
===IGPG instance=== | |||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width=100px | XML tag | !width=100px | XML tag | ||
!width=100px| | !width=100px | Content type | ||
! | ! Description | ||
|- | |- | ||
|valign=top| <IGPG id="..."> | |valign=top| <IGPG id="..."> | ||
|valign=top| integer | |valign=top| integer | ||
| instance | | instance ID | ||
|- | |- | ||
| <nowiki><Font></nowiki> | | <nowiki><Font></nowiki> | ||
Line 66: | Line 63: | ||
| <Color> | | <Color> | ||
| integer | | integer | ||
| [[wikipedia:RGB_color_model|ABGR]] range ('''A'''lpha is optional | | [[wikipedia:RGB_color_model|ABGR]] range ('''A'''lpha is optional), e.g. <Color>0 0 255 0</Color> for green | ||
|- | |- | ||
| <Size> | | <Size> | ||
Line 74: | Line 71: | ||
|valign=top| <Flags> | |valign=top| <Flags> | ||
|valign=top| flag | |valign=top| flag | ||
| Every | | Every IGPG can have its own properties. The <Flags> tag let you enable these. Add "Size" when you want to get a new font size, add "Color" when you want to get a new font color, etc. | ||
: Family | : Family | ||
: Style | : Style | ||
Line 82: | Line 79: | ||
|valign=top| <Image> | |valign=top| <Image> | ||
|valign=top| link | |valign=top| link | ||
| don't | | don't include .oni in the file name | ||
: TXMPfile_name | : TXMPfile_name | ||
: PSpcfile_name | : PSpcfile_name | ||
Line 92: | Line 89: | ||
| <Text2> | | <Text2> | ||
| integer | | integer | ||
| # + instance id, links to IGSA instance | | # + instance id, links to IGSA instance (<Text2> isn't used for HPge) | ||
|} | |} | ||
===IGSA instance=== | |||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width=100px | XML tag | !width=100px | XML tag | ||
!width=100px| | !width=100px | Content type | ||
! | ! Description | ||
|- | |- | ||
|valign=top| <IGSA id="..."> | |valign=top| <IGSA id="..."> | ||
|valign=top| integer | |valign=top| integer | ||
| instance | | instance ID | ||
|- | |- | ||
| <Strings> | | <Strings> | ||
Line 112: | Line 108: | ||
| <Link> | | <Link> | ||
| link | | link | ||
| # + instance | | # + instance ID, links to IGSt | ||
|} | |} | ||
===IGSt instance=== | |||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
!width=100px | XML tag | !width=100px | XML tag | ||
!width=100px| | !width=100px | Content type | ||
! | ! Description | ||
|- | |- | ||
|valign=top| <IGSt id="..."> | |valign=top| <IGSt id="..."> | ||
|valign=top| integer | |valign=top| integer | ||
| instance | | instance ID | ||
|- | |- | ||
| <nowiki><Font></nowiki> | | <nowiki><Font></nowiki> | ||
Line 143: | Line 138: | ||
| <Color> | | <Color> | ||
| integer | | integer | ||
| [[wikipedia:RGB_color_model|ABGR]] range ('''A'''lpha is optional | | [[wikipedia:RGB_color_model|ABGR]] range ('''A'''lpha is optional), e.g. <Color>0 0 255 0</Color> for green | ||
|- | |- | ||
| <Size> | | <Size> | ||
Line 151: | Line 146: | ||
|valign=top| <Flags> | |valign=top| <Flags> | ||
|valign=top| flag | |valign=top| flag | ||
| Every IGSt can | | Every IGSt can have its own properties. The <Flags> tag let you enable these. Add "Size" when you want to get a new font size, add "Color" when you want to get a new font color, etc. | ||
: Family | : Family | ||
: Style | : Style | ||
Line 159: | Line 154: | ||
| <Text> | | <Text> | ||
| char[384] | | char[384] | ||
| actual text; use ''<Text xml:space="preserve"> </Text>'' to create a new paragraph | | the actual text; use ''<Text xml:space="preserve"> </Text>'' to create a new paragraph | ||
|} | |} | ||
{{XML}} | {{XML}} |
Revision as of 13:58, 18 March 2021
HPge : Help Page | ||
---|---|---|
XML
FILM << Other file types >> IGHH |
General information
- The XML on this page is compatible with OniSplit v0.9.61.0.
- HPge is global (it can be found in AE/AEInstaller/vanilla/level0_Final.dat).
- There's only one HPge in Oni.
- The visual guides for the left and right HUD elements that appear at the start of Chapter 1 come from IGHHhud_help_info. HPge and IGHH get displayed at the same time.
File structure
HPge | +-- IGPG | +-- TSFF (link) +-- TXMP/PSpc (link) +-- IGSA | +-- IGSt
XML tags
HPge instance
XML tag | Content type | Description |
---|---|---|
<HPge id="..."> | integer | instance ID, should be 0 |
<Page> | link | # + instance ID, links to IGPG |
IGPG instance
XML tag | Content type | Description |
---|---|---|
<IGPG id="..."> | integer | instance ID |
<Font> | - | |
<Family> | link | TSFFfile_name.oni (without file suffix .oni) |
<Style> | flag |
|
<Color> | integer | ABGR range (Alpha is optional), e.g. <Color>0 0 255 0</Color> for green |
<Size> | integer | font size |
<Flags> | flag | Every IGPG can have its own properties. The <Flags> tag let you enable these. Add "Size" when you want to get a new font size, add "Color" when you want to get a new font color, etc.
|
<Image> | link | don't include .oni in the file name
|
<Text1> | integer | # + instance id, links to IGSA instance |
<Text2> | integer | # + instance id, links to IGSA instance (<Text2> isn't used for HPge) |
IGSA instance
XML tag | Content type | Description |
---|---|---|
<IGSA id="..."> | integer | instance ID |
<Strings> | - | |
<Link> | link | # + instance ID, links to IGSt |
IGSt instance
XML tag | Content type | Description |
---|---|---|
<IGSt id="..."> | integer | instance ID |
<Font> | - | |
<Family> | link | TSFFfile_name.oni (without file suffix .oni) |
<Style> | flag |
|
<Color> | integer | ABGR range (Alpha is optional), e.g. <Color>0 0 255 0</Color> for green |
<Size> | integer | font size |
<Flags> | flag | Every IGSt can have its own properties. The <Flags> tag let you enable these. Add "Size" when you want to get a new font size, add "Color" when you want to get a new font color, etc.
|
<Text> | char[384] | the actual text; use <Text xml:space="preserve"> </Text> to create a new paragraph |