rabiribi-map-editing/docs/events/map_transitions_and_warps.md

# Map Transitions

Map transitions are composed of three types of events:
1. An event to set the target map
2. An event to trigger the transition
3. An event in the target map to mark the destination

When the player hits a transition trigger, it warps the player to the map specified by the last "set target map" event, and tries to find the corresponding destination marker.  Note that the player continues walking as they go through the transition, so they won't end up exactly where the destination marker is.
- If the destination event is not found in the target map, the player will still warp into the target map, but at the same position within the map as where they warped from.

### Target Map Events ###

These events set the target map to transition to when the player next hits a map transition event.  Make sure the player passes through one of these before hitting a map transition event, to be sure they get directed to the correct map.
- Note: It also works if the "set target map" event is hit after hitting the map transition trigger. (i.e. while Erina is walking, before the screen fades out)

| Event ID | Target Map File |
| --- | --- |
| 161 | area0 |
| 162 | area1 |
| 163 | area2 |
| 164 | area3 |
| 165 | area4 |
| 166 | area5 |
| 167 | area6 |
| 168 | area7 |
| 169 | area8 |
| 170 | area9 |

Note: the actual game does not have any map transitions going to area6, area8 or area9, but the event triggers to transition to them still work.

### Map Transition Triggers and Targets ###

The trigger event IDs trigger the transition; the player will end up at the corresponding target event.

| Trigger Event ID | Target Event ID |
| --- | --- |
| 200 | 227 |
| 201 | 228 |
| 202 | 229 |
| 203 | 230 |
| 204 | 231 |
| 205 | 232 |
| 206 | 176 |
| 207 | 177 |

Note: 206 and 176 don't appear to be used in the official maps, but are functional regardless.

### Other Notes ###

* Map transition events do not need to be in a room marked with the "Area Transition" room type, but doing this puts the appropriate arrow icon on the map to help the player know where transitions are.
* The music that plays when coming out of a transition is based on the room color of the room you transition into. However, the music won't play properly if the music selected is the same as the one previously playing.
    * If you transition into a room with room color ID X, music ID X will start playing.

------------------------------

# Warp Stones

Note: This refers to the warp stones which bring up the warp stone select menu. The warpstone at plurkwood/forest night is not included.

A warp stone event has ID `32`. Which warp stone it is is specified by a type specifier event (i.e. ID+5000) just above the warp stone.

For example, the town warp stone has ID 5. The warp stone event is thus laid out like this:

```
+----+
|5005|
|----|
| 32 |
+----+
```

Each warp stone in Rabi-Ribi has a different ID.


### How Warp Stones work
**Short explanation**: The map you warp to is hardcoded in game. The actual location within the map depends on warp stone placement in map. If the target warp stone does not exist, you still warp but stay on the same tile.

**Proper explanation using an example**:
- Lets say from some other warp stone, you select Spectral Cave as your warp destination.
- According to the game's code, Spectral Cave is located in area0.
- Thus the game checks area0 and looks for the Spectral Cave warp stone.
    - If it finds the Spectral Cave warp stone in area0, it puts you at the location of the warp stone.
    - If it can't find the Spectral Cave warp stone in area0, it warps you to area0 anyway, but in the same tile as you were in before. We refer to this as a wrong warp.

------------------------------

# Direct Warps

Note: This refers to warps that directly bring you to another location, like the warp stone to plurkwood and the computer warp to system interior.

This can be used to:
1. Take the player to another map. (CROSS MAP X)
2. Take the player to another location, but in the same map. (CROSS MAP OFF)

**Event ID 208: Warp Entrance**
- This should be placed on the ground. The player presses Down while on the event tile to use the warp.
- The destination Tele ID and Map must be set before using the warp.
- A common practice is to surround the entrance with the Tele ID and Cross Map events.
   - This warp brings you to Map 8, Tele ID 4.
    ```
    +-----+-----+-----+-----+-----+
    | 250 | 250 | 250 | 250 | 250 | 
    |-----|-----|-----|-----|-----| 
    | 250 | 213 | 213 | 213 | 250 | 
    |-----|-----|-----|-----|-----| 
    | 250 | 213 | 208 | 213 | 250 | 
    +-----+-----+-----+-----+-----+
    ```

**Event ID 240: Warp Exit**
- The Tele ID event must be placed directly above the Warp Exit event.
    - This is a Tele ID 4 warp exit:
    ```
    +-----+
    | 213 |
    |-----|
    | 240 |
    +-----+
    ```

### Tele ID and Cross Map Events

- If you touch a Tele ID X event, the next warp you take will bring you to warp exit X.

- If you touch a CROSS MAP Y event, the next warp you take will bring you to map Y.

- If warp exit X does not exist in map Y, the warp will put you in the same location, but in map Y (wrong warp).

#### Tele ID Events:
```
209 - Tele ID 0
210 - Tele ID 1
211 - Tele ID 2
212 - Tele ID 3
213 - Tele ID 4
214 - Tele ID 5
215 - Tele ID 6
216 - Tele ID 7
217 - Tele ID 8
218 - Tele ID 9
219 - Tele ID 10
220 - Tele ID 11
```

#### Cross Map Events:
```
241 - CROSS MAP OFF
242 - CROSS MAP 0
243 - CROSS MAP 1
244 - CROSS MAP 2
245 - CROSS MAP 3
246 - CROSS MAP 4
247 - CROSS MAP 5
248 - CROSS MAP 6
249 - CROSS MAP 7
250 - CROSS MAP 8
251 - CROSS MAP 9
```
Note: If you touch CROSS MAP OFF, the next warp stone will not warp you to a different map.

**Event ID 112: Warp Stone Graphic**
  - Places a warp stone graphic 3 tiles below it. No actual effect on gameplay.
  - Only one warp stone can be placed per room
  
Note: Direct warps are disabled if the computer room background is used in the room. It is disabled until you trigger the event that activates the computer room.