Skip to main content

MapData

Struct MapData 

Source
#[non_exhaustive]
pub struct MapData<M: MapTrait, T: TilesetTrait, Mus> { pub id: M, pub width: u8, pub height: u8, pub tileset: T, pub music: Mus, pub blocks: Vec<u8>, pub warps: Vec<WarpPoint<M>>, pub npcs: Vec<NpcDefinition>, pub signs: Vec<Sign>, pub connections: MapConnections<M>, }
Expand description

Complete runtime data for a loaded map.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: M§width: u8§height: u8§tileset: T§music: Mus§blocks: Vec<u8>

Block data — the actual tile layout. Each byte is a block index into the tileset’s block definitions. Size = width * height.

§warps: Vec<WarpPoint<M>>§npcs: Vec<NpcDefinition>§signs: Vec<Sign>§connections: MapConnections<M>

Implementations§

Source§

impl<M: MapTrait, T: TilesetTrait, Mus> MapData<M, T, Mus>

Source

pub fn new( id: M, width: u8, height: u8, tileset: T, music: Mus, blocks: Vec<u8>, warps: Vec<WarpPoint<M>>, npcs: Vec<NpcDefinition>, signs: Vec<Sign>, connections: MapConnections<M>, ) -> Self

Create a new MapData with all fields.

Examples found in repository?
examples/hello_dotzuki.rs (lines 370-374)
361fn build_town_map() -> MapData<MapId, Tileset, ()> {
362    let blocks: Vec<u8> = vec![
363        0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
364        0xFF, 0x01, 0x01, 0x01, 0xFF,
365        0xFF, 0x01, 0x01, 0x01, 0xFF,
366        0xFF, 0x01, 0x01, 0x01, 0xFF,
367        0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
368    ];
369    let npcs = vec![NpcDefinition::new(0, 2, 2, NpcMovementType::Stationary, Direction::Down, 0, 0)];
370    MapData::new(
371        MapId(0), 5, 5, Tileset(0), (),
372        blocks, vec![], npcs, vec![],
373        MapConnections::default(),
374    )
375}
Source

pub fn set_block(&mut self, block_x: u8, block_y: u8, block_id: u8) -> bool

Replace the block at BLOCK coords (block_x, block_y) with block_id.

Returns false (no-op) if the coordinates fall outside the map. The collision and rendering systems read blocks live every frame, so the change takes effect immediately with no cache to invalidate. The change is transient: a map reload rebuilds blocks, so callers that need a persistent change must re-apply it on map entry.

Trait Implementations§

Source§

impl<M: Clone + MapTrait, T: Clone + TilesetTrait, Mus: Clone> Clone for MapData<M, T, Mus>

Source§

fn clone(&self) -> MapData<M, T, Mus>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M: Debug + MapTrait, T: Debug + TilesetTrait, Mus: Debug> Debug for MapData<M, T, Mus>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, M, T, Mus> Deserialize<'de> for MapData<M, T, Mus>
where M: Deserialize<'de> + MapTrait, T: Deserialize<'de> + TilesetTrait, Mus: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<M, T, Mus> Serialize for MapData<M, T, Mus>

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<M, T, Mus> Freeze for MapData<M, T, Mus>
where M: Freeze, T: Freeze, Mus: Freeze,

§

impl<M, T, Mus> RefUnwindSafe for MapData<M, T, Mus>

§

impl<M, T, Mus> Send for MapData<M, T, Mus>
where M: Send, T: Send, Mus: Send,

§

impl<M, T, Mus> Sync for MapData<M, T, Mus>
where M: Sync, T: Sync, Mus: Sync,

§

impl<M, T, Mus> Unpin for MapData<M, T, Mus>
where M: Unpin, T: Unpin, Mus: Unpin,

§

impl<M, T, Mus> UnsafeUnpin for MapData<M, T, Mus>
where M: UnsafeUnpin, T: UnsafeUnpin, Mus: UnsafeUnpin,

§

impl<M, T, Mus> UnwindSafe for MapData<M, T, Mus>
where M: UnwindSafe, T: UnwindSafe, Mus: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.