Differences

This shows you the differences between two versions of the page.

--- ff3:ff3us:doc:asm:fmt:map_propriety [2016/03/07 03:35]
m06 [Data]
+++ ff3:ff3us:doc:asm:fmt:map_propriety [2019/02/12 11:10] (current)
@@ Line 1: / Line 1: @@
-====== Map Properties ======
+====== Location Properties ======
+aka. Map Properties
 ===== Offset =====
@@ Line 9: / Line 10: @@
 | Total size                |  $357F    |
-The map number corresponds to the block index.
+The [[ff3:ff3us:doc:asm:list:maps|Location]] index corresponds to the block index.
+==== RAM ====
+Routine at ''$C0/1CAD'' will load location properties for the current location and store in RAM ''$0520''. See [[ff3:ff3us:doc:asm:ram:field_ram| Field RAM]].
 ===== Data =====
-^  Offset   ^  Mask ^ Description       ^
+^  Offset   ^ Description       ^^
-|  $ED8F00  |  $FF  | location name                 |
+|  $00  | Location Name Index                   ||
-|  $ED8F01  |  $FF  | layers animation              |
+|  $01  | Layer Effects Flags                   ||
-|  $ED8F02  |  $FF  | default battle background     |
+|  :::  |  $01  | enable X-Zone (doesn't do anything) |
-|  $ED8F03  |  $FF  | ?                             |
+|  :::  |  $02  | enable Warp (spell and item)  |
-|  $ED8F04  |  $FF  | tile proprieties              |
+|  :::  |  $04  | wavy BG3                      |
-|  $ED8F05  |  $7F  | battle proprieties            |
+|  :::  |  $08  | wavy BG2                      |
-|  :::      |  $80  | enable random battles         |
+|  :::  |  $10  | wavy BG1                      |
-|  $ED8F06  |  $FF  | ?                             |
+|  :::  |  $20  | enable spotlights             |
-|  $ED8F07  |  $FF  | tile graphic set              |
+|  :::  |  $80  | load timer graphics           |
-|  $ED8F08  |  $FF  | tile graphic set              |
+|  $02  |  $7F  | Battle Background             |
-|  $ED8F09  |  $FF  | tile graphic set              |
+|  :::  |  $80  | BG3 in Foreground             |
-|  $ED8F0A  |  $FF  | tile graphic set              |
+|  $03  | -                                     ||
-|  $ED8F0B  |  $FF  | tile formations               |
+|  $04  | [[ff3:ff3us:doc:asm:fmt:map_tile_properties | Tile Properties]] Index                 ||
-|  $ED8F0C  |  $FF  | tile formations               |
+|  $05  |  $7F  | battle proprieties            |
-|  $ED8F0D  |  $FF  | map data                      |
+|  :::  |  $80  | enable random battles         |
-|  $ED8F0E  |  $FF  | map data                      |
+|  $06  |  $03  | Window Mask Settings          |
-|  $ED8F0F  |  $FF  | map data                      |
+|  :::  |  $80  | set for colosseum guy's house (unused) |
-|  $ED8F10  |  $FF  | map data                      |
+|  $07  | 7-bit: Graphics (4) + BG3 GFX + [[ff3:ff3us:doc:asm:fmt:map_tile_sets| Tilesets]] (2)           ||
-|  $ED8F11  |  $FF  | ?                             |
+|  $08  | :::                                   ||
-|  $ED8F12  |  $FF  | background 0 shift, left      |
+|  $09  | :::                                   ||
-|  $ED8F13  |  $FF  | background 0 shift, up        |
+|  $0A  | :::                                   ||
-|  $ED8F14  |  $FF  | background 2 shift, left      |
+|  $0B  | :::                                   ||
-|  $ED8F15  |  $FF  | background 2 shift, up        |
+|  $0C  | :::                                   ||
-|  $ED8F16  |  $FF  | ?                             |
+|  $0D  | 10-bit: Tilemaps (3)                  ||
-|  $ED8F17  |  $FF  | ?layer 12 dimensions          |
+|  $0E  | :::                                   ||
-|  $ED8F18  |  $FF  | ?                             |
+|  $0F  | :::                                   ||
-|  $ED8F19  |  $FF  | palette                       |
+|  $10  | :::                                   ||
-|  $ED8F1A  |  $FF  | palette                       |
+|  $11  | Sprite Overlay Index                  ||
-|  $ED8F1B  |  $FF  | palette                       |
+|  $12  | BG2 Shift, left                       ||
-|  $ED8F1C  |  $FF  | [[ff3:ff3us:doc:asm:list:music |Music Track]] |
+|  $13  | BG2 Shift, up                         ||
-|  $ED8F1D  |  $FF  | ?                             |
+|  $14  | BG3 Shift, left                       ||
-|  $ED8F1E  |  $FF  | map width                     |
+|  $15  | BG3 Shift, up                         ||
-|  $ED8F1F  |  $FF  | map height                    |
+|  $16  | BG2/BG3 Scroll Mode                   ||
-|  $ED8F20  |  $FF  | layer proprieties             |
+|  $17  | BG1/BG2 Dimensions                    ||
+|  :::  |  $03  | BG2 Map Height Index          |
+|  :::  |  $0C  | BG2 Map Width Index           |
+|  :::  |  $30  | BG1 Map Height Index          |
+|  :::  |  $C0  | BG1 Map Width Index           |
+|  $18  | BG3 Dimensions                        ||
+|  :::  |  $0F  | <unused> (copied to RAM)      |
+|  :::  |  $30  | BG3 Map Height Index          |
+|  :::  |  $C0  | BG3 Map Width Index           |
+|  $19  | Palette Index                         ||
+|  $1A  | [[ff3:ff3us:doc:asm:fmt:palette_animation_data |Palette Animation Index]]     ||
+|  $1B  | BG Animations                         ||
+|  :::  |  $E0  | [[ff3:ff3us:doc:asm:fmt:bg3_animation_data|BG3 Animation Index]]       |
+|  :::  |  $1F  | [[ff3:ff3us:doc:asm:fmt:map_animation_data|BG1/BG2 Animation Index]]       |
+|  $1C  | [[ff3:ff3us:doc:asm:list:music |Music Track]] ||
+|  $1D  | -                                     ||
+|  $1E  | Layer mask right Edge ($00 loops)    ||
+|  $1F  | Layer mask bottom Edge               ||
+|  $20  | BG2/BG3 Color Math Mode               ||
+==== Bit Shifted Data ====
+=== 7-bit: Graphics (4) + BG3 GFX + Tilesets (2) ===
+<code>
+byte 6   byte 5   byte 4   byte 3   byte 2   byte 1
+aaaaaaab bbbbbbcc ccccdddd dddeeeee eeffffff fggggggg
+_______ _______ _______ _______ ______ ______ _______
+   |       |       |       |       |      |      |____ g: BG1/BG2 Graphics 1
+   |       |       |       |       |      |___________ f: BG1/BG2 Graphics 2
+   |       |       |       |       |__________________ e: BG1/BG2 Graphics 3
+   |       |       |       |__________________________ d: BG1/BG2 Graphics 4
+   |       |       |__________________________________ c: BG3 Graphics Index
+   |       |__________________________________________ b: BG1 Tileset Index
+   |__________________________________________________ a: BG2 Tileset Index
+</code>
+=== 10-bit: Tilemaps (3) ===
+<code>
+byte 4   byte 3   byte 2   byte 1
+--cccccc ccccbbbb bbbbbbaa aaaaaaaa
+   __________ __________ __________
+       |          |          |______ a: BG1 Tilemap Index
+       |          |_________________ b: BG2 Tilemap Index
+       |____________________________ c: BG3 Tilemap Index
+</code>
+==== BG Dimensions ====
+<code>
+-bit BG Dimensions (HEIGHTxWIDTH)
+          Size Values:  256  512 1024 2048
+Height Values (2-bit):    0    1    2    3
+ Width Values (2-bit):    0    4    8    C
+  256x256  4  256x512  8  256x1024  C  256x2048
+  512x256  5  512x512  9  512x1024  D  512x2048
+1024x256  6 1024x512  A 1024x1024  E 1024x2048
+2048x256  7 2048x512  B 2048x2048  F 2048x2048
+</code>