XML:IGHH: Difference between revisions

From OniGalore
Jump to navigation Jump to search
(IGHH + cat + temp)
 
m (oops, forgot this disambig page existed)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{XML_File_Header | type=IGHH | prev=HPge | next=IPge | name=In-game HUD }}
{{XML_File_Header | prev=IDXA | type=IGHH | next=IGPA | name=IGUI HUD Help}}


===general information===
==General information==
{| border=0 cellspacing=20 cellpadding=0 style="float:right"
* The XML on this page is compatible with OniSplit '''v0.9.61.0'''.
| [http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/HPge.jpg http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/HPge_tn.jpg]
*"IGUI" stands for "In-game User Interface". "HUD" stands for "heads-up display".
|}
* IGHH is '''global''' (it can be found in AE/AEInstaller/vanilla/level0_Final.dat).
* The xml code on this page is compatible with onisplit '''v0.9.61.0'''
* There's only one IGHH in Oni.
* IGHH is global. (It can be found in edition/GameDataFolder/level0_... )
* The [[XML:HPge|HPge]] and IGHH get displayed at the same time.
* There's only one IGHH.  
* In the following description, '''"HUD"''' refers to the health gauge, weapon display, compass, etc., and '''"HUD explanation"''' refers to the guide image with the green lines.
* HPge and IGHH becomes displayed at the same time.


==File structure==
{| class="wikitable" width="100%"
{| class="wikitable" width="100%"
!width=100px | XML tag
!width=100px | XML tag
!width=100px| content type
!width=100px | Content type
! description
! description
|-
|-
| <IGHH id="...">
| <IGHH id="...">
| integer
| integer
| instance id, should be 0
| instance ID, should be 0
|-
|-
| <LeftTexture>
| <LeftTexture>
Line 29: Line 29:
| <LeftX>
| <LeftX>
| integer
| integer
| Horizontal offset of left HUD image to left screen border.
| Horizontal relative position of left HUD explanation image (left white border) to left HUD image (left red border).
|-
|-
| <LeftY>
| <LeftY>
| integer
| integer
| Vertical offset of left HUD image to bottom screen border.
| Vertical relative position of left HUD explanation image (bottom white border) to left HUD image (bottom red border).
|-
|-
|valign=top| <RightX>
| <RightX>
|valign=top| integer
| integer
| Horizontal offset of right HUD image to right screen border.
| Horizontal relative position of right HUD explanation image (right white border) to right HUD image (right red border).
 
(The offset specifies the distance between the right edge of the screen and the left edge of the HUD image.)
|-
|-
| <RightY>
| <RightY>
| integer
| integer
| vertical offset of right HUD image to bottom screen border.
| Vertical relative position of right HUD explanation image (bottom white border) to right HUD image (bottom red border).
|-
|-
| <LeftCount>
| <LeftCount>
| integer
| integer
| Amount of elements (<IGHHLabels>) attached to left HUD image.
| Number of elements (<IGHHLabels>) attached to left HUD explanation image.
|-
|-
| <RightCount>
| <RightCount>
| integer
| integer
| Amount of elements (<IGHHLabels>) attached to right HUD image.
| Number of elements (<IGHHLabels>) attached to right HUD explanation image.
|-
|-
| <Labels>
| <Labels>
| -
| -
| You can have N <IGHHLabels> whereby N is an integer (int32).
| You can have N <IGHHLabels> where N is an integer (int32).
|-
|-
| <IGHHLabels>
| <IGHHLabels>
| -
| -
|
| Holds <Text>, <X> and <Y> tags.
|-
|-
| <Text>
| <Text>
| char[64]
| char[64]
| Legend of a HUD item, e.g. ''BALLISTIC AMMO''.
| Legend text for a HUD item, for example "BALLISTIC AMMO".
|-
|-
|valign=top| <X>
|valign=top| <X>
|valign=top| integer
|valign=top| integer
| The legend starts 77 pixels from the left border of the left HUD image.
|
[[Image:HPge.png|thumb|200px|right|Help page plus IGHH illustration.]]
 
'''For left HUD:'''
: Horizontal relative position of text to left HUD explanation image (right white border).
: For example it's 77 px for "BALLISTIC AMMO".


The integers at 0x40 are all positive. The interpretation is different depending on the part of the HUD the element is attached to.<br>
'''For right HUD:'''
For the left/right HUD, this is the horizontal distance between the left/right edge of the HUD image and the left/right edge of the legend.<br>
: Horizontal relative position of text to right HUD explanation image (left white border).
Thus the legend attached to the left HUD is to its right and the legend attached to the right HUD is to its left.
: For example it's 19 px for "OVERPOWER HEALTH".
|-
|-
| <Y>
|valign="top"| <Y>
| integer
|valign="top"| integer
| The legend starts 8 pixels from the top border of the left HUD image.
| Vertical relative position of text to the right/left HUD explanation image (top white border).
: For example it's 8 px for "BALLISTIC AMMO" and 26 px for "OVERPOWER HEALTH".
|}
|}


{{XML}}
{{XML}}

Latest revision as of 19:06, 27 March 2021

IGHH : IGUI HUD Help
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

IDXA << Other file types >> IGPA

switch to OBD page

General information

  • The XML on this page is compatible with OniSplit v0.9.61.0.
  • "IGUI" stands for "In-game User Interface". "HUD" stands for "heads-up display".
  • IGHH is global (it can be found in AE/AEInstaller/vanilla/level0_Final.dat).
  • There's only one IGHH in Oni.
  • The HPge and IGHH get displayed at the same time.
  • In the following description, "HUD" refers to the health gauge, weapon display, compass, etc., and "HUD explanation" refers to the guide image with the green lines.

File structure

XML tag Content type description
<IGHH id="..."> integer instance ID, should be 0
<LeftTexture> link TXMPfilename.oni (without file suffix .oni); "TXMPleft_help" in vanilla Oni/AE
<RightTexture> link TXMPfilename.oni (without file suffix .oni); "TXMPright_help" in vanilla Oni/AE
<LeftX> integer Horizontal relative position of left HUD explanation image (left white border) to left HUD image (left red border).
<LeftY> integer Vertical relative position of left HUD explanation image (bottom white border) to left HUD image (bottom red border).
<RightX> integer Horizontal relative position of right HUD explanation image (right white border) to right HUD image (right red border).
<RightY> integer Vertical relative position of right HUD explanation image (bottom white border) to right HUD image (bottom red border).
<LeftCount> integer Number of elements (<IGHHLabels>) attached to left HUD explanation image.
<RightCount> integer Number of elements (<IGHHLabels>) attached to right HUD explanation image.
<Labels> - You can have N <IGHHLabels> where N is an integer (int32).
<IGHHLabels> - Holds <Text>, <X> and <Y> tags.
<Text> char[64] Legend text for a HUD item, for example "BALLISTIC AMMO".
<X> integer
Help page plus IGHH illustration.

For left HUD:

Horizontal relative position of text to left HUD explanation image (right white border).
For example it's 77 px for "BALLISTIC AMMO".

For right HUD:

Horizontal relative position of text to right HUD explanation image (left white border).
For example it's 19 px for "OVERPOWER HEALTH".
<Y> integer Vertical relative position of text to the right/left HUD explanation image (top white border).
For example it's 8 px for "BALLISTIC AMMO" and 26 px for "OVERPOWER HEALTH".