Type Definition eos_rs::api::dungeons::FixedRoomId

source ·
pub type FixedRoomId = fixed_room_id;
Expand description

A fixed room ID with associated methods to get metadata.

Use the associated constants or the Self::new method to get instances of this.

Implementations§

source§

impl FixedRoomId

This impl provides general metadata about fixed rooms in the game.

source

pub const unsafe fn new(id: u32) -> Self

Returns the ID struct for the fixed room with the given ID.

Safety

The caller must make sure the ID is valid (refers to an existing fixed room), otherwise this is UB.

source

pub const fn id(&self) -> u32

Returns the ID of this fixed room.

source

pub fn is_full_floor_fixed_room(&self, _ov29: &OverlayLoadLease<29>) -> bool

Checks if this ID corresponds to a fixed, full-floor layout.

Trait Implementations§

source§

impl DungeonFixedRoomIdExt for FixedRoomId

source§

fn is_boss_fight(&self, _ov29: &OverlayLoadLease<29>) -> bool

Note: unverified, ported from Irdkwia’s notes
source§

fn are_orbs_allowed(&self, _ov29: &OverlayLoadLease<29>) -> bool

Checks if orbs are usable in the given fixed room. Read more
source§

fn are_tile_jumps_allowed(&self, _ov29: &OverlayLoadLease<29>) -> bool

Checks if tile jumps (warping, being blown away, and leaping) are allowed in the given fixed room. Read more
source§

fn are_trawl_orbs_allowed(&self, _ov29: &OverlayLoadLease<29>) -> bool

Checks if Trawl Orbs work in the given fixed room. Read more
source§

fn are_late_game_traps_enabled(&self, _ov29: &OverlayLoadLease<29>) -> bool

Check if late-game traps (Summon, Pitfall, and Pokémon traps) work in the given fixed room. Read more
source§

fn are_moves_enabled(&self, _ov29: &OverlayLoadLease<29>) -> bool

Checks if moves (excluding the regular attack) are usable in the given fixed room.
source§

fn is_room_illuminated(&self, _ov29: &OverlayLoadLease<29>) -> bool

Checks if the given fixed room is fully illuminated.
source§

impl Copy for FixedRoomId