XML:HPge: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (copy edit)
m (putting nav header parameters in more logical order)
Line 1: Line 1:
{{XML_File_Header | type=HPge | prev=FILM | next=IGHH | name=Help Page }}
{{XML_File_Header | prev=FILM | type=HPge | next=IGHH | name=Help Page}}


==General information==
==General information==

Revision as of 19:00, 27 March 2021

HPge : Help Page
XML modding tips
  • See HERE to start learning about XML modding.
  • See HERE if you are searching for information on how to handle object coordinates.
  • See HERE for some typical modding errors and their causes.
XML.png
XML

FILM << Other file types >> IGHH

switch to OBD page

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

Help page plus IGHH illustration
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
Normal
Bold
Italic
<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.
Family
Style
Color
Size
<Image> link don't include .oni in the file name
TXMPfile_name
PSpcfile_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
Normal
Bold
Italic
<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.
Family
Style
Color
Size
<Text> char[384] the actual text; use <Text xml:space="preserve"> </Text> to create a new paragraph