Struct game_library::GeneratedMaps

pub struct GeneratedMaps {
    pub biome_map: Vec<Vec<Marker>>,
    pub object_map: Vec<Vec<usize>>,
    /* private fields */
}

Stores in the generated biome map and generated object map.

This is used to store the results of the noise generation, and then used to generate the actual realm. The default map size is 1000x1000.

Fields

biome_map: Vec<Vec<Marker>>

The biome map.

object_map: Vec<Vec<usize>>

The object map.

Implementations

impl GeneratedMaps

pub const DEFAULT_SIZE: (usize, usize) = _

The default size of the map.

pub fn new(size: (usize, usize)) -> Self

Create a new Empty GeneratedMaps with the given size.

pub fn get_biome(&self, pos: Vec2) -> Marker

Ask for the biome at the given position.

Each tile is a 16x16 px but is accessed via the x and y coordinates of the tile.

The world origin is in the exact center of the map. This is represented by a 0,0 coordinate being at the middle index of the map.

pub fn map_to_world(&self, pos: (usize, usize)) -> Vec3

Function to transform map coordinates to world coordinates.

The world origin is in the exact center of the map. This is represented by a 0,0 coordinate being at the middle index of the map.

The world grid is 16x16 pixels per tile.

Note

This function has possible truncation and precision loss. This is because the world coordinates are floats and the map coordinates are usize.

Parameters

• pos: The map position to convert to world coordinates. It sets pos.z to 0.0.

Returns

The world position for the given map coordinates.

pub fn world_to_map(&self, pos: Vec3) -> (usize, usize)

Function to transform world coordinates to map coordinates.

The world origin is in the exact center of the map. This is represented by a 0,0 world coordinate being at the middle index of the map (width/2, height/2).

The world grid is 16x16 pixels per tile.

Note

This function has possible truncation and precision loss. This is because the world coordinates are floats and the map coordinates are usize.

Parameters

• pos: The world position to convert to map coordinates. pos.z is ignored.

Returns

A tuple of the x and y coordinates of the map for the given world position.

If the world position is out of bounds, then (0,0) is returned.

pub const fn dimensions(&self) -> (usize, usize)

Get the dimensions of the map.

Returns a tuple of the width and height of the map.

pub fn reset(&mut self)

Reset the maps to be empty.

This will clear the biome and object maps and reset them to be empty. It will also add the correct amount of empty vectors to the maps (just like during a new call)

pub fn reset_with_dimensions(&mut self, width: usize, height: usize)

Resets the maps to be empty and sets the dimensions to the given size.

This will clear the biome and object maps and reset them to be empty. It will also add the correct amount of empty vectors to the maps (just like during a new call) and set the dimensions to the given size.

pub fn insert_biome(&mut self, pos: Vec2, biome: Marker)

Add a biome to the map at the given position.

pub fn insert_object(&mut self, pos: Vec2, object: usize)

Add an object to the map at the given position.

pub fn push_biome(&mut self, x_pos: usize, biome: Marker)

Push a biome onto the map.

Trait Implementations

impl Clone for GeneratedMaps

fn clone(&self) -> GeneratedMaps

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratedMaps

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

Formats the value using the given formatter.

impl Default for GeneratedMaps

fn default() -> Self

Returns the “default value” for a type.

impl Hash for GeneratedMaps

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 PartialEq for GeneratedMaps

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

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

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 GeneratedMaps

impl Resource for GeneratedMaps

where Self: Send + Sync + 'static,

impl StructuralEq for GeneratedMaps

impl StructuralPartialEq for GeneratedMaps