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)
 
const absl::Status & load_status () const
 
std::optional< EntranceLayoutKind > loaded_layout_kind () const
 
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

absl::Status load_status_
 
std::optional< EntranceLayoutKind > loaded_layout_kind_
 
bool dirty_ = false
 
bool is_spawn_point_ = false
 

Detailed Description

Dungeon Room Entrance or Spawn Point.

Definition at line 120 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 123 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, yaze::Rom::is_loaded(), is_spawn_point(), yaze::zelda3::kBlockset, yaze::zelda3::kCameraXTrigger, yaze::zelda3::kCameraYTrigger, yaze::zelda3::kDoor, yaze::zelda3::kDungeon, yaze::zelda3::kExit, yaze::zelda3::kFloor, yaze::zelda3::kLadderBG, yaze::zelda3::kMusic, yaze::zelda3::kNumRegularDungeonEntrances, yaze::zelda3::kRoom, yaze::zelda3::kScrollEdge, yaze::zelda3::kScrolling, yaze::zelda3::kScrollQuadrant, yaze::zelda3::kXPosition, yaze::zelda3::kXScroll, yaze::zelda3::kYPosition, yaze::zelda3::kYScroll, ladder_bg_, yaze::zelda3::DungeonSpawnPoint::layer, yaze::zelda3::DungeonSpawnPoint::Load(), load_status_, loaded_layout_kind_, yaze::zelda3::DungeonSpawnPoint::main_gfx, music_, yaze::zelda3::DungeonSpawnPoint::overworld_door_tilemap, yaze::zelda3::DungeonSpawnPoint::quadrant, yaze::zelda3::ResolveEntranceLayout(), room_, yaze::zelda3::DungeonSpawnPoint::room_id, scroll_quadrant_, scrolling_, yaze::zelda3::DungeonSpawnPoint::song, yaze::Rom::vector(), yaze::zelda3::DungeonSpawnPoint::vertical_scroll, yaze::zelda3::DungeonSpawnPoint::x_coordinate, x_position_, yaze::zelda3::DungeonSpawnPoint::y_coordinate, and y_position_.

Member Function Documentation

◆ load_status()

const absl::Status & yaze::zelda3::RoomEntrance::load_status ( ) const
inline

Definition at line 269 of file room_entrance.h.

References load_status_.

Referenced by yaze::editor::DungeonWorkbenchContent::BuildRoomDungeonCache(), yaze::zelda3::ComputeRoomDefaultEntrances(), yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), yaze::cli::handlers::DungeonGroupCommandHandler::Execute(), yaze::editor::DungeonEditorV2::RefreshEntranceDirtyState(), and yaze::zelda3::ValidateRegularDungeonEntranceForSave().

◆ loaded_layout_kind()

std::optional< EntranceLayoutKind > yaze::zelda3::RoomEntrance::loaded_layout_kind ( ) const
inline

Definition at line 270 of file room_entrance.h.

References loaded_layout_kind_.

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

◆ dirty()

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

Definition at line 273 of file room_entrance.h.

References dirty_.

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

◆ MarkDirty()

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

Definition at line 274 of file room_entrance.h.

References dirty_.

Referenced by yaze::editor::MarkDungeonEntranceDirtyIfEditable(), and yaze::editor::anonymous_namespace{dungeon_entrance_camera.cc}::RestoreDirtyState().

◆ ClearDirty()

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

Definition at line 275 of file room_entrance.h.

References dirty_.

Referenced by yaze::editor::anonymous_namespace{dungeon_entrance_camera.cc}::RestoreDirtyState(), and Save().

◆ is_spawn_point()

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

Definition at line 276 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 278 of file room_entrance.h.

References ASSIGN_OR_RETURN, 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::kBlockset, yaze::zelda3::kCameraXTrigger, yaze::zelda3::kCameraYTrigger, yaze::zelda3::kDoor, yaze::zelda3::kDungeon, yaze::zelda3::kExit, yaze::zelda3::kFloor, yaze::zelda3::kLadderBG, yaze::zelda3::kMusic, yaze::zelda3::kRoom, yaze::zelda3::kScrollEdge, yaze::zelda3::kScrolling, yaze::zelda3::kScrollQuadrant, yaze::zelda3::kXPosition, yaze::zelda3::kXScroll, yaze::zelda3::kYPosition, yaze::zelda3::kYScroll, ladder_bg_, music_, yaze::zelda3::ResolveEntranceLayout(), RETURN_IF_ERROR, room_, scroll_quadrant_, scrolling_, yaze::zelda3::ValidateRegularDungeonEntranceForSave(), yaze::Rom::vector(), 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 369 of file room_entrance.h.

Referenced by yaze::editor::DungeonEditorV2::RestoreEntranceProperties(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and yaze::zelda3::ValidateRegularDungeonEntranceForSave().

◆ x_position_

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

Definition at line 370 of file room_entrance.h.

Referenced by yaze::editor::CaptureDungeonEntranceCamera(), 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 371 of file room_entrance.h.

Referenced by yaze::editor::CaptureDungeonEntranceCamera(), 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 372 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 373 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 374 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 375 of file room_entrance.h.

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

◆ room_

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

Definition at line 377 of file room_entrance.h.

Referenced by yaze::editor::DungeonWorkbenchContent::BuildRoomDungeonCache(), yaze::editor::CaptureDungeonEntranceCamera(), yaze::zelda3::ComputeRoomDefaultEntrances(), yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::DungeonGroupCommandHandler::Execute(), RoomEntrance(), Save(), and yaze::zelda3::ValidateRegularDungeonEntranceForSave().

◆ blockset_

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

Definition at line 378 of file room_entrance.h.

Referenced by yaze::zelda3::ComputeRoomDefaultEntrances(), yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ floor_

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

Definition at line 379 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ dungeon_id_

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

Definition at line 380 of file room_entrance.h.

Referenced by yaze::editor::DungeonWorkbenchContent::BuildRoomDungeonCache(), yaze::zelda3::ComputeRoomDefaultEntrances(), yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::DungeonGroupCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ ladder_bg_

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

Definition at line 381 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ scrolling_

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

Definition at line 382 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ scroll_quadrant_

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

Definition at line 383 of file room_entrance.h.

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

◆ exit_

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

Definition at line 384 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ music_

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

Definition at line 385 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ door_

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

Definition at line 386 of file room_entrance.h.

Referenced by yaze::cli::handlers::DungeonGetEntranceCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), RoomEntrance(), yaze::editor::anonymous_namespace{dungeon_editor_v2_entrance_camera.cc}::SameProperties(), and Save().

◆ camera_boundary_qn_

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

Definition at line 388 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 389 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 390 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 391 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 392 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 393 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 394 of file room_entrance.h.

Referenced by yaze::editor::ApplyDungeonEntranceCameraState(), yaze::editor::CaptureDungeonEntranceCamera(), 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 395 of file room_entrance.h.

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

◆ load_status_

absl::Status yaze::zelda3::RoomEntrance::load_status_
private

Definition at line 398 of file room_entrance.h.

Referenced by load_status(), and RoomEntrance().

◆ loaded_layout_kind_

std::optional<EntranceLayoutKind> yaze::zelda3::RoomEntrance::loaded_layout_kind_
private

Definition at line 399 of file room_entrance.h.

Referenced by loaded_layout_kind(), and RoomEntrance().

◆ dirty_

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

Definition at line 400 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 401 of file room_entrance.h.

Referenced by is_spawn_point().

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