yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Attributes | List of all members
yaze::zelda3::RoomEntrance Class Reference

Dungeon Room Entrance or Spawn Point. More...

#include <room_entrance.h>

Public Member Functions

 RoomEntrance ()=default
 
 RoomEntrance (Rom *rom, uint8_t entrance_id, bool is_spawn_point=false)
 
bool dirty () const
 
void MarkDirty ()
 
void ClearDirty ()
 
bool is_spawn_point () const
 
absl::Status Save (Rom *rom, int entrance_id, bool is_spawn_point=false)
 

Public Attributes

uint16_t entrance_id_ = 0
 
uint16_t x_position_ = 0
 
uint16_t y_position_ = 0
 
uint16_t camera_x_ = 0
 
uint16_t camera_y_ = 0
 
uint16_t camera_trigger_x_ = 0
 
uint16_t camera_trigger_y_ = 0
 
int16_t room_ = 0
 
uint8_t blockset_ = 0
 
uint8_t floor_ = 0
 
uint8_t dungeon_id_ = 0
 
uint8_t ladder_bg_ = 0
 
uint8_t scrolling_ = 0
 
uint8_t scroll_quadrant_ = 0
 
int16_t exit_ = 0
 
uint8_t music_ = 0
 
uint8_t door_ = 0
 
uint8_t camera_boundary_qn_ = 0
 
uint8_t camera_boundary_fn_ = 0
 
uint8_t camera_boundary_qs_ = 0
 
uint8_t camera_boundary_fs_ = 0
 
uint8_t camera_boundary_qw_ = 0
 
uint8_t camera_boundary_fw_ = 0
 
uint8_t camera_boundary_qe_ = 0
 
uint8_t camera_boundary_fe_ = 0
 

Private Attributes

bool dirty_ = false
 
bool is_spawn_point_ = false
 

Detailed Description

Dungeon Room Entrance or Spawn Point.

Definition at line 131 of file room_entrance.h.

Constructor & Destructor Documentation

◆ RoomEntrance() [1/2]

yaze::zelda3::RoomEntrance::RoomEntrance ( )
default

◆ RoomEntrance() [2/2]

yaze::zelda3::RoomEntrance::RoomEntrance ( Rom * rom,
uint8_t entrance_id,
bool is_spawn_point = false )
inline

Definition at line 134 of file room_entrance.h.

References blockset_, camera_boundary_fe_, camera_boundary_fn_, camera_boundary_fs_, camera_boundary_fw_, camera_boundary_qe_, camera_boundary_qn_, camera_boundary_qs_, camera_boundary_qw_, yaze::zelda3::DungeonSpawnPoint::camera_scroll_boundaries, yaze::zelda3::DungeonSpawnPoint::camera_scroll_controller, yaze::zelda3::DungeonSpawnPoint::camera_trigger_x, camera_trigger_x_, yaze::zelda3::DungeonSpawnPoint::camera_trigger_y, camera_trigger_y_, camera_x_, camera_y_, yaze::Rom::data(), door_, yaze::zelda3::DungeonSpawnPoint::dungeon_id, dungeon_id_, exit_, yaze::zelda3::DungeonSpawnPoint::floor, floor_, yaze::zelda3::DungeonSpawnPoint::horizontal_scroll, is_spawn_point(), yaze::zelda3::kEntranceBlockset, yaze::zelda3::kEntranceCameraXTrigger, yaze::zelda3::kEntranceCameraYTrigger, yaze::zelda3::kEntranceDoor, yaze::zelda3::kEntranceDungeon, yaze::zelda3::kEntranceExit, yaze::zelda3::kEntranceFloor, yaze::zelda3::kEntranceLadderBG, yaze::zelda3::kEntranceMusic, yaze::zelda3::kEntranceRoom, yaze::zelda3::kEntranceScrollEdge, yaze::zelda3::kEntrancescrolling, yaze::zelda3::kEntranceScrollQuadrant, yaze::zelda3::kEntranceXPosition, yaze::zelda3::kEntranceXScroll, yaze::zelda3::kEntranceYPosition, yaze::zelda3::kEntranceYScroll, ladder_bg_, yaze::zelda3::DungeonSpawnPoint::layer, yaze::zelda3::DungeonSpawnPoint::Load(), yaze::zelda3::DungeonSpawnPoint::main_gfx, music_, yaze::zelda3::DungeonSpawnPoint::overworld_door_tilemap, yaze::zelda3::DungeonSpawnPoint::quadrant, room_, yaze::zelda3::DungeonSpawnPoint::room_id, scroll_quadrant_, scrolling_, yaze::zelda3::DungeonSpawnPoint::song, yaze::zelda3::DungeonSpawnPoint::vertical_scroll, yaze::zelda3::DungeonSpawnPoint::x_coordinate, x_position_, yaze::zelda3::DungeonSpawnPoint::y_coordinate, and y_position_.

Here is the call graph for this function:

Member Function Documentation

◆ dirty()

bool yaze::zelda3::RoomEntrance::dirty ( ) const
inline

Definition at line 223 of file room_entrance.h.

References dirty_.

◆ MarkDirty()

void yaze::zelda3::RoomEntrance::MarkDirty ( )
inline

Definition at line 224 of file room_entrance.h.

References dirty_.

Referenced by yaze::editor::MarkDungeonEntranceDirtyIfEditable().

◆ ClearDirty()

void yaze::zelda3::RoomEntrance::ClearDirty ( )
inline

Definition at line 225 of file room_entrance.h.

References dirty_.

Referenced by Save().

◆ is_spawn_point()

bool yaze::zelda3::RoomEntrance::is_spawn_point ( ) const
inline

Definition at line 226 of file room_entrance.h.

References is_spawn_point_.

Referenced by yaze::editor::CanEditDungeonEntrance(), RoomEntrance(), Save(), and yaze::zelda3::ValidateRegularDungeonEntranceForSave().

◆ Save()

absl::Status yaze::zelda3::RoomEntrance::Save ( Rom * rom,
int entrance_id,
bool is_spawn_point = false )
inline

Definition at line 228 of file room_entrance.h.

References blockset_, camera_boundary_fe_, camera_boundary_fn_, camera_boundary_fs_, camera_boundary_fw_, camera_boundary_qe_, camera_boundary_qn_, camera_boundary_qs_, camera_boundary_qw_, camera_trigger_x_, camera_trigger_y_, camera_x_, camera_y_, ClearDirty(), door_, dungeon_id_, exit_, floor_, yaze::Rom::is_loaded(), is_spawn_point(), yaze::zelda3::kEntranceBlockset, yaze::zelda3::kEntranceCameraXTrigger, yaze::zelda3::kEntranceCameraYTrigger, yaze::zelda3::kEntranceDoor, yaze::zelda3::kEntranceDungeon, yaze::zelda3::kEntranceExit, yaze::zelda3::kEntranceFloor, yaze::zelda3::kEntranceLadderBG, yaze::zelda3::kEntranceMusic, yaze::zelda3::kEntranceRoom, yaze::zelda3::kEntranceScrollEdge, yaze::zelda3::kEntrancescrolling, yaze::zelda3::kEntranceScrollQuadrant, yaze::zelda3::kEntranceXPosition, yaze::zelda3::kEntranceXScroll, yaze::zelda3::kEntranceYPosition, yaze::zelda3::kEntranceYScroll, ladder_bg_, music_, RETURN_IF_ERROR, room_, scroll_quadrant_, scrolling_, yaze::zelda3::ValidateRegularDungeonEntranceForSave(), yaze::Rom::WriteByte(), yaze::Rom::WriteShort(), x_position_, and y_position_.

Member Data Documentation

◆ entrance_id_

uint16_t yaze::zelda3::RoomEntrance::entrance_id_ = 0

Definition at line 294 of file room_entrance.h.

Referenced by yaze::zelda3::ValidateRegularDungeonEntranceForSave().

◆ x_position_

uint16_t yaze::zelda3::RoomEntrance::x_position_ = 0

Definition at line 295 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ y_position_

uint16_t yaze::zelda3::RoomEntrance::y_position_ = 0

Definition at line 296 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_x_

uint16_t yaze::zelda3::RoomEntrance::camera_x_ = 0

Definition at line 297 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_y_

uint16_t yaze::zelda3::RoomEntrance::camera_y_ = 0

Definition at line 298 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_trigger_x_

uint16_t yaze::zelda3::RoomEntrance::camera_trigger_x_ = 0

Definition at line 299 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_trigger_y_

uint16_t yaze::zelda3::RoomEntrance::camera_trigger_y_ = 0

Definition at line 300 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ room_

int16_t yaze::zelda3::RoomEntrance::room_ = 0

Definition at line 302 of file room_entrance.h.

Referenced by yaze::editor::DungeonWorkbenchContent::BuildRoomDungeonCache(), yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), yaze::cli::handlers::DungeonDiscoverCommandHandler::Execute(), yaze::cli::handlers::DungeonRoomGraphCommandHandler::Execute(), yaze::cli::handlers::DungeonGroupCommandHandler::Execute(), yaze::cli::handlers::anonymous_namespace{dungeon_graph_commands.cc}::GetRoomDungeonId(), RoomEntrance(), Save(), and yaze::zelda3::ValidateRegularDungeonEntranceForSave().

◆ blockset_

uint8_t yaze::zelda3::RoomEntrance::blockset_ = 0

Definition at line 303 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ floor_

uint8_t yaze::zelda3::RoomEntrance::floor_ = 0

Definition at line 304 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ dungeon_id_

uint8_t yaze::zelda3::RoomEntrance::dungeon_id_ = 0

Definition at line 305 of file room_entrance.h.

Referenced by yaze::editor::DungeonWorkbenchContent::BuildRoomDungeonCache(), yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), yaze::cli::handlers::DungeonDiscoverCommandHandler::Execute(), yaze::cli::handlers::DungeonRoomGraphCommandHandler::Execute(), yaze::cli::handlers::DungeonGroupCommandHandler::Execute(), yaze::cli::handlers::anonymous_namespace{dungeon_graph_commands.cc}::GetRoomDungeonId(), RoomEntrance(), and Save().

◆ ladder_bg_

uint8_t yaze::zelda3::RoomEntrance::ladder_bg_ = 0

Definition at line 306 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ scrolling_

uint8_t yaze::zelda3::RoomEntrance::scrolling_ = 0

Definition at line 307 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ scroll_quadrant_

uint8_t yaze::zelda3::RoomEntrance::scroll_quadrant_ = 0

Definition at line 308 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ exit_

int16_t yaze::zelda3::RoomEntrance::exit_ = 0

Definition at line 309 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ music_

uint8_t yaze::zelda3::RoomEntrance::music_ = 0

Definition at line 310 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ door_

uint8_t yaze::zelda3::RoomEntrance::door_ = 0

Definition at line 311 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_qn_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_qn_ = 0

Definition at line 313 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_fn_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_fn_ = 0

Definition at line 314 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_qs_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_qs_ = 0

Definition at line 315 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_fs_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_fs_ = 0

Definition at line 316 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_qw_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_qw_ = 0

Definition at line 317 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_fw_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_fw_ = 0

Definition at line 318 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_qe_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_qe_ = 0

Definition at line 319 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ camera_boundary_fe_

uint8_t yaze::zelda3::RoomEntrance::camera_boundary_fe_ = 0

Definition at line 320 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), and Save().

◆ dirty_

bool yaze::zelda3::RoomEntrance::dirty_ = false
private

Definition at line 323 of file room_entrance.h.

Referenced by ClearDirty(), dirty(), and MarkDirty().

◆ is_spawn_point_

bool yaze::zelda3::RoomEntrance::is_spawn_point_ = false
private

Definition at line 324 of file room_entrance.h.

Referenced by is_spawn_point().

The documentation for this class was generated from the following file: