Struct eos_rs::ffi::dungeon_id

impl dungeon_id

This impl provides general metadata about dungeons in the game.

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

Returns the ID struct for the dungeon with the given ID.

Safety

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

pub const fn id(&self) -> u32

Returns the ID of this dungeon.

pub fn number_floors(&self) -> i32

Returns the number of floors of the given dungeon.

The result is hardcoded for certain dungeons, such as dojo mazes.

pub fn group(&self) -> DungeonGroupId

Returns the dungeon group associated to the given dungeon.

For IDs greater or equal to DungeonId::DUNGEON_NORMAL_FLY_MAZE, returns DungeonGroupId::DGROUP_MAROWAK_DOJO.

pub fn number_preceding_floors(&self) -> i32

Given a dungeon ID, returns the total amount of floors summed by all the previous dungeons in its group.

The value is normally pulled from ffi::dungeon_data_list_entry::n_preceding_floors_group, except for dungeons with an ID >= DungeonId::DUNGEON_NORMAL_FLY_MAZE, for which this function always returns 0.

pub fn number_floors_in_group(&self) -> i32

Returns the total amount of floors among all the dungeons in the dungeon group of the specified dungeon.

pub fn conv_floor_to_group_floor( &self, dungeon_floor_number: u8 ) -> (DungeonGroupId, u8)

Given this dungeon ID and a floor number, returns a struct with the corresponding dungeon group and floor number in that group.

The function normally uses the data in mappa_s.bin to calculate the result, but there’s some dungeons (such as dojo mazes) that have hardcoded return values.

pub fn goes_up(&self) -> bool

Returns whether this dungeon is considered as going upward or not

pub fn get_max_rescue_attempts(&self) -> i8

Returns the maximum rescue attempts allowed in this dungeon, or -1 if rescues are disabled.

pub fn get_leader_change_flag(&self) -> bool

Returns true if the flag that allows changing leaders is set in the restrictions of this dungeon.

pub fn is_special_joined_at_location(&self) -> bool

Returns whether this dungeon has a joined at location between DungeonId::DUNGEON_JOINED_AT_BIDOOF and DungeonId::DUNGEON_DUMMY_0xE3.

pub fn is_special_joined_at_location2(&self) -> bool

Returns whether a certain joined_at field value is equal to DungeonId::DUNGEON_BEACH or is between DungeonId::DUNGEON_DUMMY_0xEC and DungeonId::DUNGEON_DUMMY_0xF0.

pub fn are_treasure_box_drops_enabled(&self) -> bool

Checks if enemy Treasure Box drops are enabled in the dungeon.

pub const DUNGEON_DUMMY_0xFF: dungeon_id = _

Trait Implementations§

impl Clone for dungeon_id

fn clone(&self) -> dungeon_id

Returns a copy of the value. Read more

1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl From<dungeon_id> for u32

fn from(v: DungeonId) -> Self

Converts to this type from the input type.

impl Hash for dungeon_id

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher]. Read more

1.3.0§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher]. Read more

impl PartialEq<dungeon_id> for dungeon_id

fn eq(&self, other: &dungeon_id) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for dungeon_id

impl StructuralEq for dungeon_id

impl StructuralPartialEq for dungeon_id

Auto Trait Implementations§

impl RefUnwindSafe for dungeon_id

impl Send for dungeon_id

impl Sync for dungeon_id

impl Unpin for dungeon_id

impl UnwindSafe for dungeon_id

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dstwhere T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dstwhere Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere Dst: LosslessTryFrom<Src>,

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Srcwhere Dst: LossyFrom<Src>,

fn lossy_into(self) -> Dst

Performs the conversion.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dstwhere T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dstwhere T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dstwhere T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere Src: WrappingCast<Dst>,