TREE (File Format) - Revision history

>Aruki: /* Header */

2015-09-14T22:18:23Z

Header

← Older revision		Revision as of 22:18, 14 September 2015
Line 24:		Line 24:
	\| 0x4		\| 0x4
	\| u32		\| u32
	\| '''Root Node ~~Index~~'''		\| '''Root Node Instance ID'''
	\| ~~Points~~ to a SCND object named RootTreeNode.		\| Should point to a <code>SCND</code> object. The original file points to one named RootTreeNode.
	\|-		\|-
	\| 0x8		\| 0x8

>Aruki: /* SCND (Category) */

2015-09-14T22:11:29Z

SCND (Category)

← Older revision		Revision as of 22:11, 14 September 2015
Line 47:		Line 47:
	=== SCND (Category) ===		=== SCND (Category) ===

	The <code>SCND</code> object represents a category. Categories don't have very many properties; they do most of their work through the connections system instead. Category nodes are able to use their connections to mark other nodes as children. They do this by sending the message ''Attach'' (<code>ATCH</code>) to the target child node on state ''Connect'' (<code>CONN</code>). The progress bars that appear on the right side of the		The <code>SCND</code> object represents a category. Categories don't have very many properties; they do most of their work through the connections system instead. Category nodes are able to use their connections to mark other nodes as children. They do this by sending the message ''Attach'' (<code>ATCH</code>) to the target child node on state ''Connect'' (<code>CONN</code>). The progress bars that appear on the right side of the pause screen are set up automatically based on how many children the category has and how many of them are visible.

	{\| class="wikitable"		{\| class="wikitable"

>Aruki: /* Script Objects */

2015-09-14T22:10:42Z

Script Objects

← Older revision		Revision as of 22:10, 14 September 2015
Line 43:		Line 43:

	* They all include [[EditorProperties]], which contains an instance name, an "active" flag, and a position/rotation/scale, even though none of them actually needs it.		* They all include [[EditorProperties]], which contains an instance name, an "active" flag, and a position/rotation/scale, even though none of them actually needs it.
	* Every node has a name. In the data, this is represented with a resource ID for a [[STRG (Metroid Prime)\|STRG file]] ~~that~~ the name of one of the strings in that file. The name is used to look up the actual string, which is then displayed ingame in the pause menu.		* Every node has a name. In the data, this is represented with a resource ID for a [[STRG (Metroid Prime)\|STRG file]] and the name of one of the strings in that file. The name is used to look up the actual string, which is then displayed ingame in the pause menu.

	=== SCND (Category) ===		=== SCND (Category) ===

>Aruki at 22:07, 14 September 2015

2015-09-14T22:07:57Z

← Older revision		Revision as of 22:07, 14 September 2015
Line 42:		Line 42:
	The TREE format uses script objects to set up the hierarchy. There are five object types present, each representing a different node type in the hierarchy: a category, a scan, an inventory item description, an options slider, or an options menu. There are a few common parameters to all these object types:		The TREE format uses script objects to set up the hierarchy. There are five object types present, each representing a different node type in the hierarchy: a category, a scan, an inventory item description, an options slider, or an options menu. There are a few common parameters to all these object types:

	* They all include [[~~EditorParameters~~]], which contains an instance name, an "active" flag, and a position/rotation/scale, even though none of them actually needs it.		* They all include [[EditorProperties]], which contains an instance name, an "active" flag, and a position/rotation/scale, even though none of them actually needs it.
	* Every node has a name. In the data, this is represented with a resource ID for a [[STRG (Metroid Prime)\|STRG file]] that the name of one of the strings in that file. The name is used to look up the actual string, which is then displayed ingame in the pause menu.		* Every node has a name. In the data, this is represented with a resource ID for a [[STRG (Metroid Prime)\|STRG file]] that the name of one of the strings in that file. The name is used to look up the actual string, which is then displayed ingame in the pause menu.

>Aruki: Created page with "The '''TREE format''' is used to set up the pause menu hierarchy in ''Metroid Prime 2: Echoes''. It's found in 95b61279.DUMB in LogBook.pak. The format name comes from the..."

2015-09-14T22:05:35Z

Created page with "The '''TREE format''' is used to set up the pause menu hierarchy in ''Metroid Prime 2: Echoes''. It's found in 95b61279.DUMB in LogBook.pak. The format name comes from the..."

New page

The '''TREE format''' is used to set up the pause menu hierarchy in ''[[Metroid Prime 2: Echoes]]''. It's found in 95b61279.DUMB in LogBook.pak. The format name comes from the <code>TREE</code> fourCC at the beginning of the file.

{{research|minor|Unknown properties on SCSL and SCMN.}}

__TOC__

== Format ==

After the file header, the TREE format embeds a script layer using the [[Scriptable Layers (Metroid Prime 2)|scriptable layers]] format.

=== Header ===

{| class="wikitable"
! Offset
! Type
! Name
! Notes
|-
| 0x0
| char[4]
| '''Magic'''
| <code>TREE</code>
|-
| 0x4
| u32
| '''Root Node Index'''
| Points to a SCND object named RootTreeNode.
|-
| 0x8
| u8
| {{unknown|Unknown}}
| Value is 1
|-
| 0x9
| u32
| '''Instance Count'''
|
|}

== Script Objects ==

The TREE format uses script objects to set up the hierarchy. There are five object types present, each representing a different node type in the hierarchy: a category, a scan, an inventory item description, an options slider, or an options menu. There are a few common parameters to all these object types:

* They all include [[EditorParameters]], which contains an instance name, an "active" flag, and a position/rotation/scale, even though none of them actually needs it.
* Every node has a name. In the data, this is represented with a resource ID for a [[STRG (Metroid Prime)|STRG file]] that the name of one of the strings in that file. The name is used to look up the actual string, which is then displayed ingame in the pause menu.

=== SCND (Category) ===

The <code>SCND</code> object represents a category. Categories don't have very many properties; they do most of their work through the connections system instead. Category nodes are able to use their connections to mark other nodes as children. They do this by sending the message ''Attach'' (<code>ATCH</code>) to the target child node on state ''Connect'' (<code>CONN</code>). The progress bars that appear on the right side of the

{| class="wikitable"
! Property ID
! Type
! Name
|-
| 0x255A4580
| struct
| [[EditorProperties]]
|-
| 0x46219BAC
| [[STRG (Metroid Prime)|STRG]]
| Name String Table
|-
| 0x32698BD6
| string
| Name String Name
|}

=== SCSN (Scan) ===

<code>SCSN</code> represents a scan node in the logbook. They're initially invisible, but they appear when the player obtains the corresponding scan.

{| class="wikitable"
! Property ID
! Type
! Name
|-
| 0x255A4580
| struct
| [[EditorProperties]]
|-
| 0x46219BAC
| [[STRG (Metroid Prime)|STRG]]
| Name String Table
|-
| 0x32698BD6
| string
| Name String Name
|-
| 0x2DA1EC33
| struct
| [[ScannableParameters]]
|}

=== SCIN (Inventory) ===

<code>SCIN</code> works basically the same way as <code>SCSN</code>, except it's used to display descriptions of inventory items instead of logbook scans. The main difference is that <code>SCIN</code> nodes have an inventory slot parameter; they're initially hidden, and they appear when the player collects an upgrade in the corresponding slot.

{| class="wikitable"
! Property ID
! Type
! Name
|-
| 0x255A4580
| struct
| [[EditorProperties]]
|-
| 0x46219BAC
| [[STRG (Metroid Prime)|STRG]]
| Name String Table
|-
| 0x32698BD6
| string
| Name String Name
|-
| 0x3D326F90
| enum
| Inventory Slot
|-
| 0x2DA1EC33
| struct
| [[ScannableParameters]]
|}

=== SCSL (Slider) ===

<code>SCSL</code> is used to represent a slider for the options menu.

{| class="wikitable"
! Property ID
! Type
! Name
|-
| 0x255A4580
| struct
| [[EditorProperties]]
|-
| 0x46219BAC
| [[STRG (Metroid Prime)|STRG]]
| Name String Table
|-
| 0x32698BD6
| string
| Name String Name
|-
| 0x0261A4E0
| u32
| {{unknown|Unknown}}
|}

=== SCMN (Menu) ===

<code>SCMN</code> represents a multiple-choice menu for the options menu. It supports up to four menu options, although the game only uses three.

{| class="wikitable"
! Property ID
! Type
! Name
|-
| 0x255A4580
| struct
| [[EditorProperties]]
|-
| 0x46219BAC
| [[STRG (Metroid Prime)|STRG]]
| Name String Table
|-
| 0x32698BD6
| string
| Name String Name
|-
| 0x0261A4E0
| u32
| {{unknown|Unknown}}
|-
| 0xA6A874E9
| [[STRG (Metroid Prime)|STRG]]
| Menu Options String Table
|-
| 0x30531924
| string
| Option 1 String Name
|-
| 0x50BCE632
| u32
| {{unknown|Unknown}}
|-
| 0x01BB03B9
| string
| Option 2 String Name
|-
| 0x420949DC
| u32
| {{unknown|Unknown}}
|-
| 0xA7CC080D
| string
| Option 3 String Name
|-
| 0xFAB52EB9
| u32
| {{unknown|Unknown}}
|-
| 0x626B3683
| string
| Option 4 String Name
|-
| 0x67621600
| u32
| {{unknown|Unknown}}
|}

[[Category:Metroid Prime 2: Echoes]]
[[Category:File Formats]]