Ovl map mark data - Revision history

Mzxrules: Redirected page to Maps#map mark data

2018-09-13T10:45:40Z

Redirected page to Maps#map mark data

Mzxrules: /* Structure */

2018-09-11T11:29:08Z

‎Structure

Mzxrules: /* Structure */

2018-09-11T09:53:19Z

‎Structure

Mzxrules at 22:24, 25 June 2018

2018-06-25T22:24:21Z

Mzxrules at 22:23, 25 June 2018

2018-06-25T22:23:47Z

DerrikeG: Specified what happens when there's a chest and a boss door.

2015-11-09T17:04:01Z

Specified what happens when there's a chest and a boss door.

DerrikeG: Added order, room type, and structure sizes.

2015-11-09T17:02:15Z

Added order, room type, and structure sizes.

Mzxrules: /* Positioning the icons */

2014-06-17T03:31:10Z

‎Positioning the icons

Mzxrules: /* Miscellaneous Notes */

2014-06-11T03:58:44Z

‎Miscellaneous Notes

Mzxrules at 03:56, 11 June 2014

2014-06-11T03:56:40Z

← Older revision		Revision as of 10:45, 13 September 2018
Line 1:		Line 1:
−	~~{{DISPLAYTITLE:ovl_map_mark_data}}~~	+	#Redirect [[Maps#map_mark_data]]
−	~~Contains data for placing chest/boss room icons on the minimap used during game play for Scenes 0-9 (the 10 major dungeons).~~
−
−	~~== Structure ==~~
−	The overlay only contains data. At the end of the overlay's data section, there is a pointer array to the map mark data for the dungeon minimaps. Each minimap that appears in a dungeon is associated with a 0x72 byte record. The minimaps are indexed in the same order as they appear on file.
−
−	~~<pre>~~
−	~~struct~~
−	{
−	~~/* 0x00 */ s8 icon; // 0 for the chest icon, 1 for the boss room icon, FF for unused~~
−	~~/* 0x01 */ u8 count; //number of icons to display. Maximum per group is 12~~
−	~~/* 0x02 */ struct~~
−	{
−	~~/* 0x00 */ s8 chestFlag; //if specified chest flag is 0, the icon will be displayed~~
−	~~/* 0x01 */ u8 x, y; //coordinates to place the icon (top-left corner), relative to the minimap texture.~~
−
−	~~} MinimapIconPoint~~[~~12]; //0x03 bytes per record~~
−
−	~~} DungeonMinimapMarks~~[~~3]; //0x26 bytes per record, 0x72 bytes total~~
−	~~</pre>~~
−
−	~~If '''icon''' is 0 or 1, the minimap rendering routine will parse the next set of points. Once an '''icon''' set to FF is encountered, the rest of the bytes are 0.~~
−
−	~~== Positioning the Icons ==~~
−
−	The minimap textures in [[map_i_static]] are 96x85 in size. The set coordinate will position the icon from the top-left corner, rather than the center. Since the chest icon is 7x7 in size, to center a chest icon at point 48,50, subtract 4 from both x and y positions (44,46).
−
−	~~[[Category:~~ Maps]]

@@ Line 8: / Line 8: @@
 struct
+{
-     /* 0x00 */ s8? icon; // 0 for the chest icon, 1 for the boss room icon, FF for unused
+     /* 0x00 */ s8 icon; // 0 for the chest icon, 1 for the boss room icon, FF for unused
-     /* 0x01 */ u8? count; //number of icons to display. Maximum per group is 12
+     /* 0x01 */ u8 count; //number of icons to display. Maximum per group is 12
      /* 0x02 */ struct
+     {
-         /* 0x00 */ s8? chestFlag; //if specified chest flag is 0, the icon will be displayed
+         /* 0x00 */ s8 chestFlag; //if specified chest flag is 0, the icon will be displayed
-         /* 0x01 */ s8? x, y; //coordinates to place the icon (top-left corner), relative to the minimap texture.
+         /* 0x01 */ u8 x, y; //coordinates to place the icon (top-left corner), relative to the minimap texture.
      } MinimapIconPoint[12]; //0x03 bytes per record

@@ Line 3: / Line 3: @@
 == Structure ==
-The overlay notably essentially contains only raw data. At the moment, we know that at the tail end of the raw data exists a list of 10 vram offsets that point to the data for the different dungeons (which are recalculated when loaded). If you subtract the first vram offset from any other offset, you get the start of that dungeon's minimap data within the overlay's data block. The records are 0x72 bytes long and there is one for every room with a minimap, in the same order as the minimaps themselves.
+The overlay only contains data. At the end of the overlay's data section, there is a pointer array to the map mark data for the dungeon minimaps. Each minimap that appears in a dungeon is associated with a 0x72 byte record. The minimaps are indexed in the same order as they appear on file.
 <pre>
-/* 0x00 */ s8? icon; // 0 for the treasure chest icon, 1 for the boss room icon, FF for unused
+struct
 /* 0x01 */ u8? count; //number of icons to display. Maximum per group is 12
-</pre>
+    /* 0x00 */ s8? icon; // 0 for the chest icon, 1 for the boss room icon, FF for unused
-* If '''icon''' is 0 or 1, then the structure has a chance to repeat again after 38 bytes (<tt>2 bytes + 12 * the following structure size</tt>).
+    } MinimapIconPoint[12]; //0x03 bytes per record
-Following that is data about displaying each icon. Chests appear to follow the following form:
+} DungeonMinimapMarks[3]; //0x26 bytes per record, 0x72 bytes total
-<pre>
+If '''icon''' is 0 or 1, the minimap rendering routine will parse the next set of points. Once an '''icon''' set to FF is encountered, the rest of the bytes are 0.
 == Positioning the Icons ==

← Older revision		Revision as of 22:24, 25 June 2018
Line 29:		Line 29:
	The minimap textures in [[map_i_static]] are 96x85 in size. The set coordinate will position the icon from the top-left corner, rather than the center. Since the chest icon is 7x7 in size, to center a chest icon at point 48,50, subtract 4 from both x and y positions (44,46).		The minimap textures in [[map_i_static]] are 96x85 in size. The set coordinate will position the icon from the top-left corner, rather than the center. Since the chest icon is 7x7 in size, to center a chest icon at point 48,50, subtract 4 from both x and y positions (44,46).

−	[[Category: ~~Minimaps~~]]	+	[[Category: Maps]]

@@ Line 3: / Line 3: @@
 == Structure ==
-The overlay notably essentially contains only raw data. At the moment, we know that at the tail end of the raw data exists a list of 10 vram offsets that point to the data for the different dungeons (which are recalculated when loaded). If you subtract the first vram offset from any other offset, you get the start of that dungeon's minimap data within the overlay's data block. The records are 114 bytes long and there is one for every room with a minimap, in the same order as the minimaps themselves.
+The overlay notably essentially contains only raw data. At the moment, we know that at the tail end of the raw data exists a list of 10 vram offsets that point to the data for the different dungeons (which are recalculated when loaded). If you subtract the first vram offset from any other offset, you get the start of that dungeon's minimap data within the overlay's data block. The records are 0x72 bytes long and there is one for every room with a minimap, in the same order as the minimaps themselves.
 The data appears to start as such:
-<tt>iinn</tt>
+<pre>
-* '''i''' = icon to display. 0 for treasure chests, 1 for the boss icon, FF for unused.
+* If '''icon''' is 0 or 1, then the structure has a chance to repeat again after 38 bytes (<tt>2 bytes + 12 * the following structure size</tt>).
-* '''n''' = number of icons to display, the maximum number of icons to display per group is 12.
+* When there is a treasure chest and a boss door in the same room, this structure will occur twice.
+* Once an '''icon''' set to FF is encountered, the rest of the bytes are 0.
-If '''i''' is 0 or 1, then the structure has a chance to repeat again after 38 bytes (<tt>2 bytes + 12 * the following structure size</tt>).<br />
+* Up to 3 groups can occur within a single room.
 Following that is data about displaying each icon. Chests appear to follow the following form:
-<tt>ffxxyy</tt>
+<pre>
+/* 0x00 */ s8? chestFlag; //if specified chest flag is 0, the icon will be displayed
-* '''f''' = Chest flag to bind to. If the flag is 0, the icon is displayed.
+/* 0x01 */ s8? x, y; //the x,y coordinates to place the icon (top-left corner), relative to where the minimap texture is placed.
-* '''x''', '''y'''  = The x,y coordinates to place the icon (top-left corner), relative to where the minimap texture is placed. See below for tips on setting these coordinates.
+//size 0x03 bytes
-== Positioning the icons ==
+== Positioning the Icons ==
 The minimap textures in [[map_i_static]] are  96x85 in size. The set coordinate will position the icon from the top-left corner, rather than the center. Since the chest icon is 7x7 in size, to center a chest icon at point 48,50, subtract 4 from both x and y positions (44,46).
 [[Category: Minimaps]]

@@ Line 13: / Line 13: @@
 If '''i''' is 0 or 1, then the structure has a chance to repeat again after 38 bytes (<tt>2 bytes + 12 * the following structure size</tt>).<br />
-When there is a treasure chest and a boss door in the same room.<br />
+When there is a treasure chest and a boss door in the same room, this structure will occur twice.<br />
 Once a '''i''' is encountered as being FF, the rest of the bytes are null.<br />
 Up to 3 groups can occur within a single room.<br />

@@ Line 21: / Line 21: @@
 == Positioning the icons ==
-Placing the icons properly is a little confusing. The minimap textures in [[map_i_static]] are  48x85 in size, but are scaled to 96x85. So if for example you wanted to place a chest at 24,50 relative to the minimap texture, you will instead set the chest coordinates to 48,50.
+The minimap textures in [[map_i_static]] are  96x85 in size. The set coordinate will position the icon from the top-left corner, rather than the center. Since the chest icon is 7x7 in size, to center a chest icon at point 48,50, subtract 4 from both x and y positions (44,46).
 == Miscellaneous Notes ==