Struct WorldGrid 

pub struct WorldGrid {
    pub grid: HexGrid,
    pub world_size_type: WorldSizeType,
}

Represents a game world composed of grids.

Combines physical grid representation with logical world size classification for map generation and game scaling purposes.

Instantiation

WorldGrid instances can only be created through two supported methods:

1. WorldGrid::from_grid constructor - Creates from a custom-sized grid, automatically determining the WorldSizeType based on grid dimensions:

use civ_map_generator::grid::*;
use civ_map_generator::map_parameters::*;

let grid = HexGrid::new(
    Size { width: 80, height: 40 }, // Custom grid size
    HexLayout {
        orientation: HexOrientation::Flat,
        size: [8., 8.],
        origin: [0., 0.],
    }, // Hex layout
    Offset::Odd, // Odd offset for hexagonal grid
    WrapFlags::WrapX, // Wrap horizontally
);

let world_grid = WorldGrid::from_grid(grid);

2. Explicit WorldSizeType specification - Creates with default grid dimensions for a standardized world size:

use civ_map_generator::grid::*;
use civ_map_generator::map_parameters::*;

let world_size_type = WorldSizeType::Standard;
let grid = HexGrid::new(
    HexGrid::default_size(world_size_type), // Default dimensions based on world size classification
    HexLayout {
        orientation: HexOrientation::Flat,
        size: [8., 8.],
        origin: [0., 0.],
    }, // Hex layout
    Offset::Odd, // Odd offset for hexagonal grid
    WrapFlags::WrapX, // Wrap horizontally
);

let world_grid = WorldGrid::new(grid, world_size_type);

Fields

grid: HexGrid

world_size_type: WorldSizeType

Implementations

impl WorldGrid

pub fn new(grid: HexGrid, world_size: WorldSizeType) -> Self

Creates a new WorldGrid with the specified grid and world size.

Notes

Before calling this function, ensure that the grid’s size matches the specified world size. This check is performed at runtime through debug_assert!, which only activates in debug mode.

Usage

This function should be used exclusively with the initialization syntax shown below. Direct initialization with the new function outside of this pattern is not supported:

use civ_map_generator::grid::*;
use civ_map_generator::map_parameters::*;

let world_size_type = WorldSizeType::Standard;
let grid = HexGrid::new(
    HexGrid::default_size(world_size_type), // Default dimensions based on world size classification
    HexLayout {
        orientation: HexOrientation::Flat,
        size: [8., 8.],
        origin: [0., 0.],
    }, // Hex layout
    Offset::Odd, // Odd offset for hexagonal grid
    WrapFlags::WrapX, // Wrap horizontally
);

let world_grid = WorldGrid::new(grid, world_size_type);

pub fn from_grid(grid: HexGrid) -> Self

pub fn size(&self) -> Size

Get the size of the grid.

pub fn world_size(&self) -> WorldSizeType

Get the world size of the grid.

Trait Implementations

impl Clone for WorldGrid

fn clone(&self) -> WorldGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WorldGrid

impl Debug for WorldGrid

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

Formats the value using the given formatter.

impl Default for WorldGrid

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for WorldGrid

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WorldGrid