Scenes and Rooms - Revision history

Mzxrules: /* Rooms */

2023-04-30T21:05:02Z

‎Rooms

Mzxrules at 16:31, 23 March 2021

2021-03-23T16:31:05Z

CDi-Fails: One more clarification!

2021-02-21T17:24:01Z

One more clarification!

CDi-Fails: Whoopsie, jumped the gun on the last edit

2021-02-21T05:28:09Z

Whoopsie, jumped the gun on the last edit

CDi-Fails at 03:17, 21 February 2021

2021-02-21T03:17:29Z

Fig: /* Lighting List */

2020-12-23T08:54:00Z

‎Lighting List

Mzxrules at 15:05, 26 August 2019

2019-08-26T15:05:12Z

Mzxrules: /* Transition Actors */

2019-04-01T05:21:35Z

‎Transition Actors

Nokaubure: /* Type 2 */

2018-10-17T00:05:30Z

‎Type 2

Mzxrules: /* Path List */

2018-08-10T14:31:50Z

‎Path List

@@ Line 253: / Line 253: @@
 |-
 | 0x10 || ✔ || Time Settings
 |-
 | 0x0A || ✔ || Room Mesh

@@ Line 356: / Line 356: @@
 === Type 1 ===
-This format is used with certain pre-rendered areas, specifically to render a static background image rather than the panoramas. Notably, the JFIF image is rendered via the [[S2DEX]] microcode, rather than the primary rendering microcode ([[F3DZEX]]). The JFIF is drawn using S2DEX's gsSPBgRectCopy (0x0A) macro.
+This format is used with certain pre-rendered areas, specifically to render a static background image rather than the panoramas. Notably, the JFIF image is rendered via the [[S2DEX]] microcode, rather than the primary rendering microcode ([[F3DZEX2]]). The JFIF is drawn using S2DEX's gsSPBgRectCopy (0x0A) macro.
 ==== Header Format ====

@@ Line 413: / Line 413: @@
 === Type 2 ===
-Mesh that culls if the camera is not a certain depth from a set point.
+Mesh that culls if the camera behind a set point by a certain distance.
 ==== Header Format ====
@@ Line 428: / Line 428: @@
 '''b''' = Y coordinate<br>
 '''c''' = Z coordinate<br>
-'''d''' = depth from camera to start culling<br>
+'''d''' = distance from camera to start culling<br>
 '''x''' = display list with opaque geometry. Set to 0 if unused.<br>
 '''y''' = display list with translucent geometry. Set to 0 if unused.<br>

@@ Line 413: / Line 413: @@
 === Type 2 ===
-Mesh that clips if the player is not within a spherical culling boundary.
+Mesh that culls if the camera is not a certain depth from a set point.
 ==== Header Format ====
@@ Line 428: / Line 428: @@
 '''b''' = Y coordinate<br>
 '''c''' = Z coordinate<br>
-'''d''' = radius of culling sphere<br>
+'''d''' = depth from camera to start culling<br>
 '''x''' = display list with opaque geometry. Set to 0 if unused.<br>
 '''y''' = display list with translucent geometry. Set to 0 if unused.<br>

@@ Line 413: / Line 413: @@
 === Type 2 ===
-Mesh that clips if the player is not within certain bounds.
+Mesh that clips if the player is not within a spherical culling boundary.
 ==== Header Format ====
@@ Line 425: / Line 425: @@
 <tt>aaaabbbb ccccdddd xxxxxxxx yyyyyyyy</tt> (repeats for each entry)<br>
 Where:<br>
-'''a''' and '''b''' = X and Z maximum player coordinates to render first display list from<br>
+'''a''' = X coordinate<br>
-'''c''' and '''d''' = X and Z minimum player coordinates to render first display list from<br>
+'''b''' = Y coordinate<br>
 '''x''' = display list with opaque geometry. Set to 0 if unused.<br>
 '''y''' = display list with translucent geometry. Set to 0 if unused.<br>

@@ Line 524: / Line 524: @@
 * '''a''' = Ambient light color, <tt>RRGGBB</tt> format. Usually <tt>0x462D39</tt>
-* '''b''' = First diffuse light color [illumination of Link from upside], <tt>RRGGBB</tt> format. Usually <tt>0x494949</tt>
+* '''b''' = First light direction <tt>XXYYZZ</tt> format. Usually <tt>0xB49A8A</tt>
-* '''c''' = First diffuse light direction <tt>XXYYZZ</tt> format. Usually <tt>0xB49A8A</tt>
+* '''c''' = First light color, <tt>RRGGBB</tt> format. Usually <tt>0x494949</tt>
-* '''d''' = Second diffuse light color [illumination of Link from downside], <tt>RRGGBB</tt> format. Usually <tt>0xB7B7B7</tt>.
+* '''d''' = Second light direction, <tt>XXYYZZ</tt> format.  Usually <tt>0x14143C</tt>
-* '''e''' = Second diffuse light direction, <tt>XXYYZZ</tt> format.  Usually <tt>0x14143C</tt>
+* '''e''' = Second light color, <tt>RRGGBB</tt> format. Usually <tt>0xB7B7B7</tt>
 * '''f''' = Fog color, <tt>RRGGBB</tt> format
-* '''g & 0xFC00''' = Unknown but evaluated property
+* '''g & 0xFC00''' = Blend rate between light settings
-* '''g & 0x03FF''' = Fog start
+* '''g & 0x03FF''' = Fog near, how close fog starts
-* '''h''' = Draw distance
+* '''h''' = Fog far, how far until fog saturates
 ==Exit List==

@@ Line 1: / Line 1: @@
 {{article link|Scenes and Rooms}}
 ==Header Commands==
-The header commands are designed to define the bulk of the structure for Scene and Room files.
+The header commands are designed to define the bulk of the structure for Scene and Room files. All commands follow the following 8 byte structure:
 {| class="wikitable"
@@ Line 162: / Line 170: @@
 |Sound settings
 |<tt>15xx0000 0000yyzz</tt>
-|'''x''' = reverb (max value 0x0E)<br>'''y''' = [[Music Sequences#Nighttime SFX|Nighttime SFX]] to play, 0x13 = always playing day sequence<br>'''z''' = [[Music Sequences|Music sequence]] to play, 0x7F = always playing Nighttime SFX<br><sub>Nighttime SFX documented by Strati</sub>
+|'''x''' = Settings config, max value 0x11. See [[#Sound_Settings|Sound Settings]]<br>'''y''' = [[Music Sequences#Nighttime SFX|Nighttime SFX]] to play, 0x13 = always playing day sequence<br>'''z''' = [[Music Sequences|Music sequence]] to play, 0x7F = always playing Nighttime SFX<br><sub>Nighttime SFX documented by Strati</sub>
 |scenes
 | No
@@ Line 529: / Line 537: @@
 Check out the [[Collision_Format|collision format]] for more information about exits.
 ==Alternate Header List==

@@ Line 491: / Line 491: @@
 ==Transition Actors==
-Transition actors are scene level actors that swap the room that is loaded. A maximum of 64 transition actors can exist per scene. Transition actors don't typically (if ever) have their own collision, it must be part of the collision specified by the collision command in the scene header.
+Transition actors are scene level actors that swap the room that is loaded. A maximum of 64 transition actors can exist per scene. Transition actors don't have their own collision, it must be part of the collision specified by the collision command in the scene header.
 Format:<br>

@@ Line 469: / Line 469: @@
 ==Path List==
-Actors which have a "route" to follow, such as the carpenters or the graveyard boy, do not have the route hard-coded within them. Instead, the points which they make straight lines to are mapped out in a list. That is, a point is marked at every turning point, and they follow straight lines between the turning points. The data pointed to by the scene header is a list of:<br>
+Actors which have a "route" to follow, such as the carpenters or the graveyard boy, do not have the route hard-coded within them. Instead, the points which they make straight lines to are mapped out in a list. That is, a point is marked at every turning point, and they follow straight lines between the turning points.
-<tt>aa000000 llllllll</tt> (repeats for each path)<br>
-Where:<br>
+The data pointed to by the scene header is an array of the following struct:
-'''a''' is the number of points for the given path, and<br>
-'''l''' is the location of the first point of the path<br>
+<pre>
-The path pointer list at offset '''l''' has '''a''' entries, each consisting of:<br>
+/* 0x00 */ s8 numPoints; //number of points for the given path
-<tt>xxxx yyyy zzzz</tt> (repeats for each point of path)<br>
+/* 0x04 */ SegmentAddress pathStart; //location of first point of the path
-'''x''', '''y''', and '''z''' are the (signed) coordinates of the specific point on the path.<br>
+//size 0x08 bytes
-<br>
+</pre>
 xdaniel figured this out while working on [[SayakaGL]], and the information was verified by spinout by reversal of a function which reads the data. ([http://spinout182.com/mqd/En_Cs.S Graveyard boy @ func_809E1E90]) ([http://i.imgur.com/KPvs4.png SayakaGL Implementation])
 ==Transition Actors==
 Transition actors are scene level actors that swap the room that is loaded. A maximum of 64 transition actors can exist per scene. Transition actors don't typically (if ever) have their own collision, it must be part of the collision specified by the collision command in the scene header.