Enum Spatula 

pub enum Spatula {
    // some variants omitted
}

Convenient definition for every spatula in the game

Menu coordinates:

Spatula has support for interpeting a (usize, usize) value as a coordinate from the in-game menu, where the first coordinate is the level-index and the second coordinate is the spatula-index, and convert it to a Spatula value (or vice-versa).

use bfbb::Spatula;

let coord = (0,3);
let spatula = Spatula::try_from(coord).expect("'(0,3)' should be Spongebob's Closet");
assert_eq!(spatula, Spatula::SpongebobsCloset);

let closet = Spatula::SpongebobsCloset;
let coord: (usize, usize) = closet.into();
assert_eq!(coord, (0,3))

Implementations

impl Spatula

pub fn get_offset(&self) -> Option<usize>

In-game, spatula objects are stored within an array of entities. get_offset gets the index of a spatula within that entity array.

NOTE: These indexes are only valid while the spatula’s level is loaded.

NOTE: This list is currently only validated for the Gamecube version of the game.

pub fn get_level(&self) -> Level

Returns the level this spatula is in.

use bfbb::{Level, Spatula};

let closet = Spatula::SpongebobsCloset;
let level = closet.get_level();
assert_eq!(level, Level::SpongebobHouse);

Trait Implementations

impl Clone for Spatula

fn clone(&self) -> Spatula

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spatula

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spatula

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnumCount for Spatula

const COUNT: usize = 84usize

impl From<Spatula> for (usize, usize)

fn from(spatula: Spatula) -> Self

Converts to this type from the input type.

impl Hash for Spatula

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<V: InterfaceBackend> Index<Spatula> for Tasks<V>

type Output = Task<V>

The returned type after indexing.

fn index(&self, index: Spatula) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: InterfaceBackend> IndexMut<Spatula> for Tasks<T>

fn index_mut(&mut self, index: Spatula) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoEnumIterator for Spatula

type Iterator = SpatulaIter

fn iter() -> SpatulaIter

impl PartialEq for Spatula

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Spatula

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(usize, usize)> for Spatula

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: (usize, usize)) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Spatula

impl Eq for Spatula

impl StructuralPartialEq for Spatula