DZB - Revision history

LagoLunatic: Add unknown group attribute bits

2022-04-21T03:08:31Z

Add unknown group attribute bits

LagoLunatic: Document water current path

2021-04-29T22:05:42Z

Document water current path

LagoLunatic: Document another property field

2020-08-26T05:13:23Z

Document another property field

LagoLunatic: Documented property bitfield 4

2020-08-26T02:15:08Z

Documented property bitfield 4

LagoLunatic: Document Sea Floor Audio Info attribute for groups

2020-07-30T20:01:32Z

Document Sea Floor Audio Info attribute for groups

LagoLunatic: Document another group field

2020-07-30T17:48:33Z

Document another group field

LagoLunatic: Fix group bitfield being under the Properties header instead of the Groups header

2020-07-26T22:49:10Z

Fix group bitfield being under the Properties header instead of the Groups header

Jasper: Rearranging Groups before Properties

2020-02-09T17:16:14Z

Rearranging Groups before Properties

Jasper at 17:15, 9 February 2020

2020-02-09T17:15:02Z

Jasper at 17:14, 9 February 2020

2020-02-09T17:14:47Z

@@ Line 192: / Line 192: @@
 | 0x00000200 || Is Lava ||
 |-
-| 0x00000400 || Unused 1 ||
+| 0x00000400 || Unknown 1 || Another attribute bit like Water/Lava, but this one appears unused. Checked in dBgW::ChkGrpThrough.
 |-
 | 0x0007F800 || Sea Floor Audio Info || Officially called "Sound ID", this value is used by the audio system to determine what music to play and what sound banks to load for each sector on the sea. It is 0 for groups that are not part of the sea floor. For groups that are part of the sea floor, bits & 0x3F are the room number this sea floor belongs to. If bit & 0x40 is set, it is the "Inner Sea" part of the sector's sea floor (the center, not near the edge of a sector). If bit & 0x80 is set, it is the "Outer Edge" part of the sector's sea floor (the outermost border of the sector). If neither bit & 0x40 nor bit & 0x80 are set, it is the "Inner Edge" part of the sector's sea floor (the thin border in between the "Inner Sea" and "Outer Edge" parts). Note that collision belonging to room 0 of the sea is slightly different - it is always considered to be part of the sea floor (specifically known as the "Outer Sea"), even if this value is 0.
 |-
-| 0xFFF80000 || Unused 2 ||
+| 0x00080000 || Unknown 2 || Another attribute bit like Water/Lava, but this one appears unused. Checked in dBgW::ChkGrpThrough.
 |-
 |}

@@ Line 265: / Line 265: @@
 | 0x0000FF00 || Room Cam ID || ?
 |-
-| 0x00FF0000 || Room Path ID || ?
+| 0x00FF0000 || Water Current Room Path Index || Index of a room path that represents a water current's directions. Some objects (specifically the ship, Link when swimming, and crate-type pots) will move along this water current if in water and directly above collision with this field set.
 |-
-| 0xFF000000 || Room Path Pnt No || ?
+| 0xFF000000 || Water Current Room Path Point Index || Index of a point in the above room path. This point represents the direction the water flows from, and the next point represents the direction it flows towards.
 |}

@@ Line 233: / Line 233: @@
 |-
 | 0x07F80000 || PolyColor || ?
 |}
@@ Line 280: / Line 282: @@
 | 0x00000004 || Pass 2 Link || Allows Link to pass through this surface.
 |-
-| 0x00000008 || Pass 3 Arrows and Light || Allows arrows and reflected rays of light to pass through this surface. Also prevents actor shadows from being drawn on this surface.
+| 0x00000008 || Pass 3 Arrows and Light || Allows arrows and reflected rays of light to pass through this surface. Also prevents actor shadows from being drawn on this surface. (Only real shadows, does not disable drop shadows.)
 |-
 | 0x00000010 || Hookshottable || Allows the hookshot to stick to this surface so the player can pull themself to it.

@@ Line 216: / Line 216: @@
 | <center>0x08</center> || <center>4</center> || Bitfield 3 || See below
 |-
-| <center>0x0C</center> || <center>4</center> || Camera Behavior ||
+| <center>0x0C</center> || <center>4</center> || Bitfield 4 || See below
 |-
 |}
@@ Line 266: / Line 266: @@
 |-
 | 0xFF000000 || Room Path Pnt No || ?
 |}

@@ Line 194: / Line 194: @@
 | 0x00000400 || Unused 1 ||
 |-
-| 0x0007F800 || Sound ID ||
+| 0x0007F800 || Sea Floor Audio Info || Officially called "Sound ID", this value is used by the audio system to determine what music to play and what sound banks to load for each sector on the sea. It is 0 for groups that are not part of the sea floor. For groups that are part of the sea floor, bits & 0x3F are the room number this sea floor belongs to. If bit & 0x40 is set, it is the "Inner Sea" part of the sector's sea floor (the center, not near the edge of a sector). If bit & 0x80 is set, it is the "Outer Edge" part of the sector's sea floor (the outermost border of the sector). If neither bit & 0x40 nor bit & 0x80 are set, it is the "Inner Edge" part of the sector's sea floor (the thin border in between the "Inner Sea" and "Outer Edge" parts). Note that collision belonging to room 0 of the sea is slightly different - it is always considered to be part of the sea floor (specifically known as the "Outer Sea"), even if this value is 0.
 |-
 | 0xFFF80000 || Unused 2 ||

@@ Line 172: / Line 172: @@
 | <center>0x2A</center> || <center>2</center> || Room Index || Index of the room this group belongs to.
 |-
-| <center>0x2C</center> || <center>2</center> || Unknown 2 ||
+| <center>0x2C</center> || <center>2</center> || First Vertex Index || The lowest vertex index that belongs to this group. For groups with no faces, this is 0 instead. This field does not seem to be read or have any effect.
 |-
 | <center>0x2E</center> || <center>2</center> || Octree Root Node Index ||

@@ Line 177: / Line 177: @@
 |-
 | <center>0x30</center> || <center>4</center> || Bitfield || See below
 |-
 |}
@@ Line 246: / Line 266: @@
 |-
 | 0xFF000000 || Room Path Pnt No || ?
 |}

@@ Line 128: / Line 128: @@
 |-
 | <center>0x00</center> || <center>2</center> || Starting Triangle Index ||
 |-
 |}
@@ Line 197: / Line 246: @@
 |-
 | 0xFF000000 || Room Path Pnt No || ?
 |}

@@ Line 56: / Line 56: @@
 |}
-== Faces ==
+== Triangles ==
-Faces are made up of 3 indexes into the vertex section, in addition to indexes for the group they belong to and the property they use.
+Triangles are made up of 3 indexes into the vertex section, in addition to indexes for the group they belong to and the property they use.
 Size: 0xA bytes.

@@ Line 16: / Line 16: @@
 | <center>0x04</center> || <center>4</center> || Vertices Offset ||
 |-
-| <center>0x08</center> || <center>4</center> || Faces Count ||
+| <center>0x08</center> || <center>4</center> || Triangles Count ||
 |-
-| <center>0x0C</center> || <center>4</center> || Faces Offset ||
+| <center>0x0C</center> || <center>4</center> || Triangles Offset ||
 |-
-| <center>0x10</center> || <center>4</center> || Octree Indexes Count ||
+| <center>0x10</center> || <center>4</center> || Blocks Count ||
 |-
-| <center>0x14</center> || <center>4</center> || Indexes Offset ||
+| <center>0x14</center> || <center>4</center> || Blocks Offset ||
 |-
-| <center>0x18</center> || <center>4</center> || Octree Nodes Count ||
+| <center>0x18</center> || <center>4</center> || Tree Nodes Count ||
 |-
-| <center>0x1C</center> || <center>4</center> || Octree Offset ||
+| <center>0x1C</center> || <center>4</center> || Tree Nodes Offset ||
 |-
 | <center>0x20</center> || <center>4</center> || Groups Count ||
@@ Line 65: / Line 65: @@
 ! Offset                !! Size               !! Name || Description
 |-
-| <center>0x00</center> || <center>2</center> || Vertex 3 Index ||
+| <center>0x00</center> || <center>2</center> || Vertex 1 Index ||
 |-
-| <center>0x02</center> || <center>2</center> || Vertex 3 Index ||
+| <center>0x02</center> || <center>2</center> || Vertex 2 Index ||
 |-
 | <center>0x04</center> || <center>2</center> || Vertex 3 Index ||
@@ Line 78: / Line 78: @@
 == Octree ==
-In order to speed up collision detection, DZB uses an octree to partition parts of the mesh into separate spaces. It is split between two sections: the actual Tree and octree Indexes.
+In order to speed up collision detection, DZB uses an octree to partition parts of the mesh into separate spaces. It is split between two sections: the node tree, and blocks.
-=== Tree ===
+=== Node Tree ===
-The octree is made up of branch and leaf nodes. Each group in the file that actually has collision assigned to it contains the index of the group's root leaf. From there, the tree grows until a certain
+The node tree is made up of branch and leaf nodes. Each group in the file that actually has collision assigned to it contains the index of the group's root node.
-Nodes have two forms, which are differentiated by a boolean, which will be named IsLeafNode. If it is false, the node is a branch and contains the indexes
+Nodes have two forms, which are differentiated by the Flags field. Branch nodes have 8 sub-children. There is no required spatial ordering to the children blocks, as best I can tell. The code checks the children in a strange order (2 3 6 7 0 1 4 5), implying this is not just an array of children, but the checks for each of the children are the exact same.
-of other branches or leaves for each octant of the space to be subdivided. If it is true, the node is a leaf and contains the index to an index in the octree Indexes section.
 Size: 0x14 bytes.
@@ Line 93: / Line 93: @@
 ! Offset                !! Size               !! Name || Description
 |-
-| <center>0x00</center> || <center>1</center> || Magic Byte || Always 1.
+| <center>0x00</center> || <center>2</center> || Flags || Low bit is set if a leaf node, otherwise it is a branch node. All other fields are ignored.
 |-
 | <center>0x02</center> || <center>2</center> || Parent Node Index ||
 |-
-| <center>0x04</center> || <center>2</center> || Octant 1 Branch Index || If this is a leaf node, this field instead contains an index into the Octree Indexes section. All other fields after this would be filled with 0xFF.
+| <center>0x04</center> || <center>2</center> || Octant 1 Branch Index || If this is a leaf node, this field instead contains an index into the Blocks section. All other fields after this would be filled with 0xFF.
 |-
 | <center>0x06</center> || <center>2</center> || Octant 2 Branch Index ||
@@ Line 117: / Line 115: @@
 |}
-=== Indexes ===
+=== Blocks ===
-This is the index of a face for the octree to use. By some currently unknown association, this face and others related to it become part of the octant of the leaf that referenced it.
 Size: 2 bytes.
@@ Line 126: / Line 127: @@
 ! Offset                !! Size               !! Name || Description
 |-
-| <center>0x00</center> || <center>2</center> || Face Index ||
+| <center>0x00</center> || <center>2</center> || Starting Triangle Index ||
 |-
 |}