Tutorial:Modification and Addition of Switches - Revision history

Mzxrules at 15:13, 6 August 2021

2021-08-06T15:13:35Z

ShimmerFairy: /* Switch Flags */ I'm shocked someone would accidentally link to the wrong global context page.

2020-09-20T19:42:12Z

‎Switch Flags: I'm shocked someone would accidentally link to the wrong global context page.

Mzxrules: /* Switch Flags */

2019-06-08T16:54:48Z

‎Switch Flags

Nokaubure: /* Lifting Door */

2018-08-04T18:56:33Z

‎Lifting Door

Rinku: /* Alternate Door Skins */

2016-09-17T11:07:24Z

‎Alternate Door Skins

Mzxrules: /* Alternate Door Skins */ Transposed tables, clarified object list ordering comment (order is important, but doesn't mutate door)

2016-09-17T06:04:40Z

‎Alternate Door Skins: Transposed tables, clarified object list ordering comment (order is important, but doesn't mutate door)

Show changes

Rinku: /* Alternate Door Skins */

2016-09-16T14:22:33Z

‎Alternate Door Skins

Rinku: Finished alternate door section.

2016-09-16T14:21:36Z

Finished alternate door section.

Rinku: /* Alternate Door Skins */

2016-09-16T08:21:58Z

‎Alternate Door Skins

Rinku: /* Alternate Door Skins */

2016-09-16T08:18:29Z

‎Alternate Door Skins

@@ Line 29: / Line 29: @@
 |}
-The RAM address for the current scene's switch flags is 80213D48 in the Debug Rom. See [[Global Context (Game)]] for other versions. The zone-out type variable is located at [[Save Context]] + 0x1364, and is normally set to the following values:
+The RAM address for the current scene's switch flags is 80213D48 in the Debug Rom. See [[Game Play Struct]] for other versions. The zone-out type variable is located at [[Save Context]] + 0x1364, and is normally set to the following values:
 <pre>
 /* zoneoutTypes
@@ Line 75: / Line 75: @@
 See [[Modification and Addition of Switches#Chest|Chest]] for an explanation of the chest actors parameters.
-The RAM address for the current scene's chest flags is 80213D58. See [[Global Context]] for other versions.
+The RAM address for the current scene's chest flags is 80213D58. See [[Game Play Struct]] for other versions.
 ====Clear Flags====
@@ Line 84: / Line 84: @@
 Many actors have a way to attach to the room's clear flag, which will be discussed below.
-The RAM address for the current scene's clear flag is 80213D5C. See [[Global Context]] for other versions.
+The RAM address for the current scene's clear flag is 80213D5C. See [[Game Play Struct]] for other versions.
 === Global Event Flags ===

@@ Line 29: / Line 29: @@
 |}
-The RAM address for the current scene's switch flags is 80213D48 in the Debug Rom. See [[Global Context]] for other versions. The zone-out type variable is located at [[Save Context]] + 0x1364, and is normally set to the following values:
+The RAM address for the current scene's switch flags is 80213D48 in the Debug Rom. See [[Global Context (Game)]] for other versions. The zone-out type variable is located at [[Save Context]] + 0x1364, and is normally set to the following values:
 <pre>
 /* zoneoutTypes

@@ Line 17: / Line 17: @@
 ====Switch Flags====
-Switch Flags are by far the most important group of flags. They control just about everything in the scene not mentioned elsewhere. There are 64 switch flags in a scene, which can be divided into three groups.<br>
+Switch Flags are by far the most important group of flags. They control just about everything in the scene not mentioned elsewhere. There are 64 switch flags in a scene, which can be divided into three groups.
 {| class="wikitable"
@@ Line 24: / Line 24: @@
 | Permanent flags || 00-1F || Keep their values when you leave the current scene or save. Never affected by other scenes.
 |-
-| Temporary flags || 20-37 || Cleared when you leave a scene via specific type of exit (typically on leaving a dungeon)?
+| Temporary flags || 20-37 || Cleared or preserved on leaving a scene, depending on the zone-out type variable set.
 |-
-| Local flags || 38-3F || Cleared every time you change rooms
+| Local flags || 38-3F || Cleared every time a room unloads.
 |}
-The RAM address for the current scene's switch flags is 80213D48 in the Debug Rom. See [[Global Context]] for other versions.
+The RAM address for the current scene's switch flags is 80213D48 in the Debug Rom. See [[Global Context]] for other versions. The zone-out type variable is located at [[Save Context]] + 0x1364, and is normally set to the following values:
 There are a few important things to note.
@@ Line 35: / Line 45: @@
 Farore's Wind copies the state of the temporary flags ''as they were when entering the room'' when cast, and restores this state when you warp back, regardless of what their current values are.  This holds true even if you are warping between two different rooms of the same dungeon.
-It is generally good idea to never attach anything to switch flag 3F. Several actors use "attached to 3F" as a shorthand for "not attached to anything" or "attached to clear flag".  It can be done, but it'll save you a lot of headache to just not do it.
+Never attach events to switch flag 3F. Several actors use "attached to 3F" as a shorthand for "not attached to anything" or "attached to clear flag".  It can be done, but it'll save you a lot of headache to just not do it.
-It is a bad idea for two adjacent rooms to use the same local flag.  This is because the next room will load before the flags are cleared, and you may set off things in the next room you didn't intend to.
+It is a bad idea for two adjacent rooms to use the same local flag.  This is because the next room will load before the flags are cleared when the previous room unloads, which can trigger events in the next room you didn't intend to.
 Lastly, in dungeons with a boss key, switch 0x14 is reserved for the boss door.  Don't use it.

@@ Line 147: / Line 147: @@
 ===Lifting Door===
-E 0YY0 + 00XX, Object 0002<br>
+E 0YY0 + 00XX, Object 0001<br>
 XX = Switch Flag<br>

@@ Line 389: / Line 389: @@
 If a dungeon has alternate door skins for certain types of doors only (e.g.: Deku tree has alternate door skins for locked doors only (actor 002E, specific variable)), these doors will need their corresponding object and work as explained above. However, the doors which do not have an alternate door skin in this dungeon (e.g.: Deku tree has no alternate door skins for standard doors (actor 0009) and lifting doors (actor 002E, variable 0000)) will use their standard door skins, depending on whether objects 0001 and 0002 or objects 0001 and 0003 are loaded.
-As with any actor, in order to prevent doors with custom skins from unloading, it's important to make sure that any objects you don't want to unload are listed in the same order between the two transitions. As such, the best way to prevent doors with custom skins from unloading is to place the dependent object at or near the first position in the object list for all maps within a scene that require the door skin.
+As with any actor, in order to prevent doors with custom skins from unloading during transition between two maps, it's important to make sure that any objects you don't want to unload are listed in the same order and in the same object list position between the two transitions. As such, the best way to prevent doors with custom skins from unloading is to place the dependent object at or near the first position in the object list for all maps within a scene that require the door skin.
 Without modifying the actor in question, it isn't possible to load an alternate skin for a different dungeon. It even doesn’t matter if, say, in the Fire temple, the object used for alternate door skins of the Water temple is first in the object list and the object used for Fire temple alternate door skins is second only; the scene will always use the Fire temple alternate door skins, because, as explained above, each scene always uses its native alternate door skins.
@@ Line 404: / Line 404: @@
 | Dungeon Scenes || 0001, 0003 || [[File:SDoor0003.JPG|thumbnail]] || [[File:LDoor0001.JPG|thumbnail]] || Lifting door + regular bars || Lifting door + regular key lock
 |-
-| Deku tree || object 0036 || Standard skin (object 0002 or 0003) || Standard skin (object 0001) || [[File:LDoor0036locked.JPG|thumbnail]] || Same as bar-locked, but with key lock instead of bars
+| Deku tree || 0036 || Standard skin (object 0002 or 0003) || Standard skin (object 0001) || [[File:LDoor0036locked.JPG|thumbnail]] || Same as bar-locked, but with key lock instead of bars
 |-
 | Dodongo’s cavern || 002B || Standard skin (object 0002 or 0003) || [[File:LDoor002B.JPG|thumbnail]] || [[File:LDoor002Blocked.JPG|thumbnail]] || Same as bar-locked, but with key lock instead of bars: key lock too small for the door, not intended to be used
@@ Line 437: / Line 437: @@
 ! Location || Objects || Visual
 |-
-| Overworld Scenes || 0002, 00B0 || [[File:LDoorBoss0002.JPG|thumbnail]]
+| Overworld Scenes || 0002, 00B0<br />(corruption <br />because<br />0003 not<br />loaded) || [[File:LDoorBoss0002.JPG|thumbnail]]
 |-
 | Dungeon Scenes || 0003, 00B0 || [[File:LDoorBoss0003.JPG|thumbnail]]

@@ Line 477: / Line 477: @@
 ! Required objects and scene → Required actor ↓ !! Most scenes (object 0002 and 00B0) !! Most scenes (object 0003 and 00B0) !! Deku tree
 (object 0003 and 00B0, no others needed)
-  !! Dodongo’s cavern (object 0003 and 00B0, no others needed) !! Jabu-Jabu’s belly (object 0003 and 00B0, no others needed) !! Forest temple (object 0003 and 00B0, no others needed) !! Fire temple (object 0003 and 00B0, no others needed) !! Water temple (object 0003 and 00B0, no others needed) !! Spirit temple (object 0003 and 00B0, no others needed) !! Shadow temple / Bottom of the well (object 0003 and 00B0, no others needed) !! Ice cavern (object 0003 and 00B0, no others needed) !! Ganon’s tower (object 0003 and 00B0, no others needed) !! Gerudo training grounds (object 0003 and 00B0, no others needed) !! Ganon’s castle (object 0003 and 00B0, no others needed)
+  ! Dodongo’s cavern (object 0003 and 00B0, no others needed) !! Jabu-Jabu’s belly (object 0003 and 00B0, no others needed) !! Forest temple (object 0003 and 00B0, no others needed) !! Fire temple (object 0003 and 00B0, no others needed) !! Water temple (object 0003 and 00B0, no others needed) !! Spirit temple (object 0003 and 00B0, no others needed) !! Shadow temple / Bottom of the well (object 0003 and 00B0, no others needed) !! Ice cavern (object 0003 and 00B0, no others needed) !! Ganon’s tower (object 0003 and 00B0, no others needed) !! Gerudo training grounds (object 0003 and 00B0, no others needed) !! Ganon’s castle (object 0003 and 00B0, no others needed)
 |-
 | Boss door (actor 002E) ||

@@ Line 375: / Line 375: @@
 =Alternate Door Skins=
 Actors 0009 (standard door) and 002E (lifting door) can both use alternate door skins. This is scene dependant. In most scenes, the lifting door will use its default skin (object 0001, always loaded); the standard door will use one of two default skins based on which special object is loaded for the scene (0002 or 0003).
@@ Line 399: / Line 397: @@
 It is not known where the game decides that each scene can only use its native alternate door skins. However, it has been tested that it is defined neither in the scene header (as the alternate door skins depend on the scene ID (entry in the scene table) and not on the scene header, otherwise changing a scene’s alternate door skins would be fairly simple), nor in the scene table of the code. It can be assumed that it’s either somewhere else in the code, or in the corresponding actor files of the doors.
 {| class="wikitable"
 |-
-! Header text !! Most scenes (objects 0001 and 0002) !! Most scenes (objects 0001 and 0003) !! Deku tree
+! Required objects and scene → Required actor ↓ !! Most scenes (objects 0001 and 0002) !! Most scenes (objects 0001 and 0003) !! Deku tree
 '''(object 0036)'''
   ! Dodongo’s cavern
@@ Line 494: / Line 468: @@
 | Lifting key-locked door (actor 002E) || Lifting door + regular key lock || Lifting door + regular key lock || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars: key lock too small for the door, not intended to be used || Key-lock floating in mid-air, corrupt red textures far to the left; not intended to be used || Lifting door + regular key lock || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars; the key lock has longer chains to fit the door’s size || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars
 |}
 Bar-locked lifting doors are only shown when different from regular lifting doors; in the case of Dodongo’s cavern and Spirit temple, the doors look the same but the bars are different, therefore pictures have been provided. Key-locked doors always look the same as the corresponding bar-locked door, but with the bar replaced by a key lock (which may or may not adjust its size to the door’s size, see table for details).
 =Credits=

@@ Line 490: / Line 490: @@
   ||
 [[File:LDoor0187locked.JPG|thumbnail]]
-  || Ice lifting door + regular bars || Ganon’s tower lifting door + regular bars || Gerudo lifting door + regular bars || Ganon’s castle lfting door + regular bars
+  || Ice lifting door + regular bars || Ganon’s tower lifting door + regular bars || Gerudo lifting door + regular bars || Ganon’s castle lifting door + regular bars
 |-
 | Lifting key-locked door (actor 002E) || Lifting door + regular key lock || Lifting door + regular key lock || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars: key lock too small for the door, not intended to be used || Key-lock floating in mid-air, corrupt red textures far to the left; not intended to be used || Lifting door + regular key lock || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars; the key lock has longer chains to fit the door’s size || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars

@@ Line 463: / Line 463: @@
   ||
 [[File:LDoor0001.JPG|thumbnail]]
-  || Standard skin (object 0001) || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example
+  || Standard skin (object 0001) ||
 |-
-| Lifting bar-locked door (actor 002E) || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example
+| Lifting bar-locked door (actor 002E) || Lifting door + regular bars || Lifting door + regular bars ||
 |-
-| Lifting key-locked door (actor 002E) || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example || Example
+| Lifting key-locked door (actor 002E) || Lifting door + regular key lock || Lifting door + regular key lock || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars: key lock too small for the door, not intended to be used || Key-lock floating in mid-air, corrupt red textures far to the left; not intended to be used || Lifting door + regular key lock || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars; the key lock has longer chains to fit the door’s size || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars || Same as bar-locked, but with key lock instead of bars
 |}
 =Credits=