Struct eos_rs::api::gameplay::AdventureLog

pub struct AdventureLog(_);

Adventure log helper

Implementations

impl AdventureLog

pub unsafe fn get() -> Self

Returns an internal reference to the adventure log. Note that this isn’t a reference to the actual struct in memory (yet).

Safety

This is unsafe, since it essentially borrows a global variable mutably, see safety rules for static muts.

pub fn set_struct_location(&mut self)

Sets the location of the adventure log struct in memory.

Sets it in a static memory location.

pub fn clear_struct(&mut self)

Clears the adventure log structure.

pub fn get_dungeon_floor(&self) -> dungeon_floor_pair

Returns the current dungeon floor pair.

pub fn set_dungeon_floor(&mut self, dungeon_floor: dungeon_floor_pair)

Sets the current dungeon floor pair.

pub fn is_entry_completed(&self, entry_id: u32) -> bool

Checks if one adventure log entry is completed.

pub fn mark_entry_completed(&mut self, entry_id: u32)

Marks one of the adventure log entry as completed.

pub fn is_empty(&self) -> bool

Checks if none of of the adventure log entry is completed.

pub fn get_number_dungeons_cleared(&self) -> u32

Gets the number of dungeons cleared.

pub fn increment_number_dungeons_cleared()

Increments by 1 the number of dungeons cleared.

pub fn get_number_friend_rescues(&self) -> u32

Gets the number of successful friend rescues.

pub fn increment_number_friend_rescues(&mut self)

Increments by 1 the number of successful friend rescues.

pub fn get_number_evolutions(&self) -> u32

Gets the number of evolutions.

pub fn increment_number_evolutions(&mut self)

Increments by 1 the number of evolutions.

pub fn increment_number_steals(&mut self)

Leftover from Time & Darkness. Does not do anything.

Calls to this matches the ones for incrementing the number of successful steals in Time & Darkness.

pub fn get_number_eggs_hatched(&self) -> u32

Gets the number of eggs hatched.

pub fn increment_number_eggs_hatched(&mut self)

Increments by 1 the number of eggs hatched.

pub fn get_number_monsters_joined(&self) -> u32

Gets the number of different monsters that joined.

pub fn get_number_moves_learned(&self) -> u32

Gets the number of different moves learned.

pub fn get_victories_on_one_floor(&self) -> u32

Gets the record of victories on one floor.

pub fn set_victories_on_one_floor(&mut self, victories: u32)

Sets the record of victories on one floor.

pub fn get_number_monsters_battled(&self) -> u32

Gets the number of different monsters that battled against you.

pub fn set_monster_battled(&mut self, monster_id: MonsterSpeciesId)

Marks one monster as battled.

pub fn set_monster_joined(&mut self, monster_id: MonsterSpeciesId)

Marks one monster as joined.

pub fn get_number_big_treasure_wins(&self) -> u32

Gets the number of big treasure wins.

pub fn increment_number_of_big_treasure_wins()

Increments by 1 the number of big treasure wins.

pub fn set_number_big_treasure_wins(&mut self, number: u32)

Sets the number of big treasure wins.

pub fn get_number_recycled(&mut self) -> u32

Gets the number of items recycled.

pub fn set_number_recycled(&mut self, number: u32)

Sets the number of items recycled.

pub fn get_number_sky_gifts_sent(&self) -> u32

Gets the number of Sky Gifts sent.

pub fn increment_number_of_gifts_sent()

Increments by 1 the number of sky gifts sent.

pub fn set_number_sky_gifts_sent(&mut self, number: u32)

Sets the number of Sky Gifts sent.

pub fn compute_special_counters(&mut self)

Computes the counters from the bit fields in the adventure log, as they are not updated automatically when bit fields are altered.

Affects Self::get_number_monsters_joined, Self::get_number_moves_learned, Self::get_number_monsters_battled and Self::get_number_items_acquired.

pub fn set_special_monster_recruited(&mut self, monster_id: MonsterSpeciesId)

Marks a specified special monster as recruited in the adventure log.

pub fn get_number_fainted(&self) -> u32

Gets the number of times the player fainted.

pub fn increment_number_of_fainted()

Increments by 1 the number of times the player fainted.

pub fn get_number_items_acquired(&self) -> u32

Gets the number of items acquired.

pub fn set_item_acquired(&mut self, item_id: ItemId)

Marks one specific item as acquired.

pub fn set_challenge_letter_cleared(&mut self, challenge_letter: u32)

Sets a challenge letter as cleared.

pub fn get_sentry_duty_game_points(&self, rank: SentryGameRank) -> u32

Gets the points for the associated rank in the footprints minigame.

pub fn set_sentry_duty_game_points( &mut self, points: u32 ) -> Option<SentryGameRank>

Sets the points for the associated rank in the footprints minigame.