HINT (File Format): Difference between revisions

From Retro Modding Wiki
Jump to navigation Jump to search
imported>Antidote
No edit summary
imported>Antidote
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The '''HINT format''' is used to manage the hint system, controlling what hints pop up, what they say, and where they point to.
The '''HINT format''' is used to manage the hint system, controlling what hints pop up, what they say, and where they point to.


{{researchminor|reason=There are a couple unknown fields.}}
{{research|1|There are a couple unknown fields.}}


__TOC__
__TOC__
Line 43: Line 43:
| float
| float
| 1
| 1
| {{unknown|'''Unknown'''}}
| '''Immediate Time'''
|-
|-
| float
| float
| 1
| 1
| '''Appear time'''; the amount of time that passes from when the hint is activated to when it appears on the HUD
| '''Normal time'''; the amount of time that passes from when the hint is activated to when it appears on the HUD
|-
|-
| u32/u64
| u32/u64
| 1
| 1
| '''Pop-up text STRG ID''' u32 in Metroid Prime 1/2, u64 in Metroid Prime 3
| '''Pop-up text STRG ID'''; u32 in Metroid Prime 1/2, u64 in Metroid Prime 3
|-
|-
| u32
| float
| 1
| 1
| {{unknown|'''Unknown'''}}
| '''Text Time'''
|-
|-
| u32
| u32
| 1
| 1
| {{unknown|'''Unknown'''}}
| '''Location Count'''
|-
| [[#HintLocation|HintLocation]]
| locationCount
| '''Hint Locations'''; Areas where this hint appears.
|}
 
===HintLocation===
 
{| class="wikitable"
! Type
! Count
! Description
|-
|-
| u32
| u32
| 1
| 1
| '''Target world MLVL ID''' ''Note: Not in Metroid Prime 3''
| '''Target world MLVL ID'''
|-
|-
| u32
| u32
| 1
| 1
| '''Target room MREA ID''' ''Note: Not In Metroid Prime 3''
| '''Target room MREA ID'''
|-
|-
| u32
| u32
| 1
| 1
| '''Target room index''' (position in MLVL file) ''Note: Not In Metroid Prime 3''
| '''Target room index'''
|-
|-
| u32
| u32
| 1
| 1
| '''Map text STRG ID''' ''Note: Not In Metroid Prime 3''
| '''Map text STRG ID'''
|-
|-
| colspan=3 {{unknown|End of entry}}
| colspan=5 {{unknown|End of entry}}
|}
|}


[[Category:File Formats]]
[[Category:File Formats]]

Latest revision as of 11:45, 25 May 2017

The HINT format is used to manage the hint system, controlling what hints pop up, what they say, and where they point to.


This file format is almost completely documented
There are a couple unknown fields.


Format

Header

Offset Size Description
0x0 4 Magic; always 0x00BADBAD
0x4 4 Version; 1 in Prime/Echoes, 3 in Corruption
0x8 4 Hint count
0xC Hint entries start

Hint

Type Count Description
string 1 Hint name
float 1 Immediate Time
float 1 Normal time; the amount of time that passes from when the hint is activated to when it appears on the HUD
u32/u64 1 Pop-up text STRG ID; u32 in Metroid Prime 1/2, u64 in Metroid Prime 3
float 1 Text Time
u32 1 Location Count
HintLocation locationCount Hint Locations; Areas where this hint appears.

HintLocation

Type Count Description
u32 1 Target world MLVL ID
u32 1 Target room MREA ID
u32 1 Target room index
u32 1 Map text STRG ID
End of entry