Entrance Table - Revision history

Mzxrules: /* Transition Animations */

2019-10-25T05:49:45Z

‎Transition Animations

Mzxrules: /* Look-up Routine */

2019-06-16T23:48:39Z

‎Look-up Routine

Mzxrules at 09:12, 6 June 2019

2019-06-06T09:12:05Z

Playtendo at 08:11, 13 May 2018

2018-05-13T08:11:29Z

Mzxrules: /* Other Info */

2017-11-14T07:24:52Z

‎Other Info

Mzxrules: /* Other Info */

2017-11-14T07:13:19Z

‎Other Info

Mzxrules: /* Transition Animations */

2017-02-06T14:37:05Z

‎Transition Animations

Mzxrules: /* Transition Animations */

2016-06-01T16:24:44Z

‎Transition Animations

Mzxrules: /* Transition Animations */

2016-01-01T19:12:56Z

‎Transition Animations

Mzxrules at 18:43, 1 January 2016

2016-01-01T18:43:34Z

@@ Line 44: / Line 44: @@
 |-
 | 0F || Fast fade to sandstorm, sets sandstorm animation on leaving, ends animation on entering
 |-
 | 2C || Shortcut Transition Animation

@@ Line 51: / Line 51: @@
 == Look-up Routine ==
-A somewhat confusing aspect of the entrance table is that the developers use a routine that indirectly looks up the entrance table based on 4 different variables: a "base" index, Link's age, the time of day, and variable used to load cutscene setups (we'll call it the cutscene number).
+When resolving a spawn, the entrance table is not looked up directly. Instead, a "final" entrance index is computed usually by using the following variables:
-The base index can be thought of as being the starting point to an array of possible entrances.
+The order of operations is something like this:
-* If the cutscene number's value is 0x0000, the look-up index = base index, +1 if night, +2 if Link is an adult
+* The base entrance index is checked to see if it's -1. If so, the game goes back to the title screen.
-* If the cutscene number's value is 0xFFF0-0xFFFF, the look-up index = base index, +4, + the rightmost hex digit in the cutscene number.
+* The next cutscene number variable is read.
 This means that for every spawn location, you will need 4 sequential records on the entrance table. If you wish to trigger a cutscene stored within a scene setup, you will also need additional records for each cutscene you want to spawn at. Nintendo conserves space by using the same base index (which ends up being the entrance with the lowest index) for all cutscenes within a scene.

@@ Line 20: / Line 20: @@
 * '''Scene''' is the [[scene]] index used to reference what scene to load.
 * '''Spawn''' sets what "entrance" within the scene to spawn at. Additionally, this value affects dynamic exits, and is used to determine which Fairy Fountain you've entered (see below). Entrances are defined by the Entrance List scene/room command. See [[Scenes_and_Rooms#Entrance_List|Scenes and Rooms: Entrance List]].
 === Transition Animations ===
@@ Line 49: / Line 47: @@
 | 2C || Shortcut Transition Animation
 |}
 == Look-up Routine ==

@@ Line 14: / Line 14: @@
 // & 8000 = Continue playing background music when exiting. 0 stops it, 1 continues playing it.
-// & 4000 = ? (Sets property in Link)
+// & 4000 = Displays title card. (Also sets property in Link?)
 // & 3F80 = Fade In Transition Animation
 // & 007F = Fade Out Transition Animation

@@ Line 87: / Line 87: @@
 === Soft Reset Functionality ===
-Index 0x7FFF will "soft reset" the game, returning you to the title screen
+Setting an entrance index of -1 (0xFFFF or 0xFFFFFFFF, depending on the variable size) will "soft reset" the game, returning you to the title screen.
 === Dynamic Exits ===
 Indexes 0x7FF9 - 0x7FFE are used for dynamic scene exits, enabling the devs to reuse the same scenes. When Link touches an exit set to one of these index values, a table look-up is performed based on the index, plus the entrance id for the area spawned in.
 :''[[ovl_player_actor]] (Debug):''
@@ Line 101: / Line 99: @@
 C233AE - Exit list for index 7FF9 (Great Fairy Fountain, Magic Spells)
 </pre>
 ==== Example ====

@@ Line 81: / Line 81: @@
 * For every {{actor ref|23}} spawned, the actor will run a check once per frame to see if the current entrance index is 00EE (Kokiri Forest's cutscene entrance), and the current scene setup is 8. If both conditions are true, the actor will force two rooms to load simultaneously when Link walks near one.
 * On every frame, a check located within [[code]] is performed on the current entrance index to see if it's value is 00CD (Hyrule Field cutscene entrance)
 === Entrance Cutscenes ===

@@ Line 43: / Line 43: @@
 | 07 || Very slow fade to/from white during the day, slow fade to/from black during night
 |-
-| 0F || Sandstorm
+| 0E || Slow fade into sandstorm, sets sandstorm animation leaving, keeps animation running
 |-
 | 2C || Shortcut Transition Animation

@@ Line 25: / Line 25: @@
 === Transition Animations ===
 {|class="wikitable"
-| 01 || Triforce transition
+! Id || Transition Animation
 |-
-| 0F || Sandstorm Transition
+| 00 || Spiky (Glitched?)
 |}

@@ Line 1: / Line 1: @@
 {{For|a listing of the contents of the entrance table|Entrance Table (Data)}}
-{{Address|file=[[code|Code (File)]]|asset=Entrance Table|
+{{address3|space=code|name=Entrance Table
-{{Addr|version=Debug|rom-start=00B9F360|rom-end=00BA0BB0|size=1850}}|
+|ver1=Debug|ref1=rom|start1=B9F360|size1=1850
-{{Addr|version=NTSC 1.0|rom-start=00B6FBF0|rom-end=00B71440|size=1850}}|
+|ver2=NTSC 1.0|ref2=rom|start2=B6FBF0|size2=1850
-{{Addr|version=NTSC 1.2|rom-start=00B6FC00|rom-end=00B71450|size=1850}}
+|ver3=NTSC 1.2|ref3=rom|start3=B6FC00|size3=1850}}
 The entrance table is used to create a means of linking between scenes. Each entrance record stores 4 bytes of data, and the table indexer is typically stored as a signed short, but the table lookup routine will ignore the sign bit, such that index 0x8000 equivalent to 0x0000 for example.
 == Format ==
-<pre>sseevvtt</pre>
+<syntaxhighlight lang="csharp">
-* '''s''' is the Scene number to load
+/*0x00*/ byte Scene;
-* '''e''' sets what "entrance" within the scene to spawn at. Additionally, this value affects dynamic exits, and is used to determine which Fairy Fountain you've entered (see below). Entrances are defined by the Entrance List scene/room command. See [[Scenes_and_Rooms#Entrance_List|Scenes and Rooms: Entrance List]].
+/*0x01*/ byte Spawn;
-* '''v''' is a variable used to control certain behaviors (ex. whether to cut the music short) when transitioning to a new entrance
+/*0x02*/ short Variable //Bitpacked variable defined as below:
-=== Transitions ===
+// & 8000 = Continue playing background music when exiting. 0 stops it, 1 continues playing it.
 {|class="wikitable"
 | 01 || Triforce transition
@@ Line 76: / Line 84: @@
 If you walk into the Great Fairy Fountain (Upgrades) from Death Mountain Trail, the following entrance look-up will occur.
-<table class="wikitable">
+{|class="wikitable"
-<tr><th>Index</th><th>Scene</th><th>Entrance</th><th>Variable</th><th>Transition</th><th>Scene Name</th><th>Spawn Info</th></tr>
+!Index||Scene||Entrance||Variable||Scene Name||Spawn Info
-<tr><td>04BE</td><td>3B</td><td>01</td><td>41</td><td>02</td><td>Great Fairy's Fountain (Upgrades)</td><td>From Death Mountain Crater</td></tr>
+|-
-</table>
+|04BE||3B||01||4102||Great Fairy's Fountain (Upgrades)||From Death Mountain Crater
 This sets the spawn entrance to (01). Then later when you touch the exit (which is set to 7FFE), The game will look at the two byte value at C2339A (2 * entrance + C2339A).
 [[Category:Code (File)]]