Struct Site 

pub struct Site {
    pub origin: Vec2<i32>,
    name: Option<String>,
    pub tiles: TileGrid,
    pub plots: Store<Plot>,
    pub plazas: Vec<Id<Plot>>,
    pub roads: Vec<Id<Plot>>,
    pub economy: Option<Box<Economy>>,
    pub kind: Option<SiteKind>,
}

Fields

origin: Vec2<i32>

name: Option<String>

tiles: TileGrid

plots: Store<Plot>

plazas: Vec<Id<Plot>>

roads: Vec<Id<Plot>>

economy: Option<Box<Economy>>

kind: Option<SiteKind>

Implementations

impl Site

pub fn filter_plots<'a, F: FnMut(&'a Plot) -> bool>( &'a self, f: F, ) -> Filter<impl ExactSizeIterator<Item = &'a Plot>, impl FnMut(&&'a Plot) -> bool>

pub fn any_plot<F: FnMut(&Plot) -> bool>(&self, f: F) -> bool

pub fn meta(&self) -> Option<SiteKindMeta>

pub fn economy_mut(&mut self) -> &mut Economy

pub fn do_economic_simulation(&self) -> bool

pub fn trade_information(&self, id: Id<Site>) -> Option<SiteInformation>

pub fn radius(&self) -> f32

pub fn spawn_rules(&self, wpos: Vec2<i32>) -> SpawnRules

pub fn bounds(&self) -> Aabr<i32>

pub fn plot(&self, id: Id<Plot>) -> &Plot

pub fn plots(&self) -> impl ExactSizeIterator<Item = &Plot> + '_

pub fn plazas(&self) -> impl ExactSizeIterator<Item = Id<Plot>> + '_

pub fn create_plot(&mut self, plot: Plot) -> Id<Plot>

pub fn blit_aabr(&mut self, aabr: Aabr<i32>, tile: Tile)

pub fn create_road( &mut self, land: &Land<'_>, a: Vec2<i32>, b: Vec2<i32>, w: u16, kind: RoadKind, ) -> Option<Id<Plot>>

pub fn find_aabr( &mut self, search_pos: Vec2<i32>, area_range: Range<u32>, min_dims: Extent2<u32>, ) -> Option<(Aabr<i32>, Vec2<i32>, Vec2<i32>, Option<i32>)>

pub fn find_roadside_aabr( &mut self, rng: &mut impl Rng, area_range: Range<u32>, min_dims: Extent2<u32>, ) -> Option<(Aabr<i32>, Vec2<i32>, Vec2<i32>, Option<i32>)>

pub fn find_rural_aabr( &mut self, rng: &mut impl Rng, area_range: Range<u32>, min_dims: Extent2<u32>, ) -> Option<(Aabr<i32>, Vec2<i32>, Vec2<i32>, Option<i32>)>

pub fn make_plaza_at( &mut self, land: &Land<'_>, index: IndexRef<'_>, tile_aabr: Aabr<i32>, rng: &mut impl Rng, road_kind: RoadKind, ) -> Option<Id<Plot>>

pub fn make_plaza( &mut self, land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, generator_stats: &mut SitesGenMeta, site_name: &str, road_kind: RoadKind, ) -> Option<Id<Plot>>

pub fn demarcate_obstacles(&mut self, land: &Land<'_>)

pub fn make_initial_plaza( &mut self, land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, plaza_radius: u32, search_inner_radius: u32, search_width: u32, generator_stats: &mut SitesGenMeta, site_name: &str, road_kind: RoadKind, ) -> Option<Id<Plot>>

The find_roadside_aabr function wants to have an existing plaza or road. This function is used to find a suitable location for the first plaza in a town, which has the side-effect of creating at least one road. This function is more expensive than the make_plaza function but fails to find a plaza location only if there are no suitable locations within the entire search radius.

It works by exhaustively finding all tiles within a ring pattern around the town center where the tile and all surrounding tiles to the plaza radius are not hazards or roads. It then chooses the tile with the minimum distance from the town center as the plaza location. See the comments in common/src/spiral.rs for more information on the spiral ring pattern.

demarcate_obstacles() should be called before this function to mark the obstacles and roads. (Cliff Towns are an exception).

pub fn make_initial_plaza_default( &mut self, land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, generator_stats: &mut SitesGenMeta, site_name: &str, road_kind: RoadKind, ) -> Option<Id<Plot>>

This is make_initial_plaza with default options/parameters. This calls make_initial_plaza with the default parameters for the plaza_radius and search_inner_radius. The plaza_radius will be in the range 1-3, and the search_inner_radius will be 7 + plaza_radius. The search_width will be PLAZA_MAX_SEARCH_RADIUS - search_inner_radius. The search_inner_radius is approximately the same distance from the center of town as for the original make_plaza function, so this function will place the initial plaza and roads near where the original make_plaza function would place them in the case where the site is clear of hazards.

This default plaza generation function is used for generating cities, cliff towns, savannah towns, and coastal towns. The other town types (terracotta, myrmidon, desert city) have a central feature so they use specific plaza generation parameters and call the make_initial_plaza function directly.

demarcate_obstacles() should be called before this function to mark the obstacles and roads.

pub fn name(&self) -> Option<&str>

pub fn generate_mine( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_citadel( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_gnarling( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_adlet( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, index: IndexRef<'_>, ) -> Self

pub fn generate_terracotta( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, generator_stats: &mut SitesGenMeta, ) -> Self

pub fn generate_myrmidon( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, generator_stats: &mut SitesGenMeta, ) -> Self

pub fn generate_giant_tree( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_city( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, size: f32, calendar: Option<&Calendar>, generator_stats: &mut SitesGenMeta, ) -> Self

pub fn generate_glider_course( land: &Land<'_>, _index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_cliff_town( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, generator_stats: &mut SitesGenMeta, ) -> Self

pub fn generate_savannah_town( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, generator_stats: &mut SitesGenMeta, ) -> Self

pub fn generate_coastal_town( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, generator_stats: &mut SitesGenMeta, ) -> Self

pub fn generate_desert_city( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, generator_stats: &mut SitesGenMeta, ) -> Self

pub fn generate_farm( is_desert: bool, rng: &mut impl Rng, site: &mut Site, land: &Land<'_>, ) -> bool

pub fn generate_barn( is_desert: bool, rng: &mut impl Rng, site: &mut Site, land: &Land<'_>, index: IndexRef<'_>, ) -> bool

pub fn generate_haniwa( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_chapel_site( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_pirate_hideout( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_jungle_ruin( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_rock_circle( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_troll_cave( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_camp( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_cultist( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_sahagin( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_vampire_castle( land: &Land<'_>, rng: &mut impl Rng, origin: Vec2<i32>, ) -> Self

pub fn generate_bridge( land: &Land<'_>, index: IndexRef<'_>, rng: &mut impl Rng, start_chunk: Vec2<i32>, end_chunk: Vec2<i32>, ) -> Self

pub fn wpos_tile_pos(&self, wpos2d: Vec2<i32>) -> Vec2<i32>

pub fn wpos_tile(&self, wpos2d: Vec2<i32>) -> &Tile

pub fn tile_wpos(&self, tile: Vec2<i32>) -> Vec2<i32>

pub fn tile_center_wpos(&self, tile: Vec2<i32>) -> Vec2<i32>

pub fn render_tile(&self, canvas: &mut Canvas<'_>, tpos: Vec2<i32>)

pub fn render(&self, canvas: &mut Canvas<'_>, dynamic_rng: &mut impl Rng)

pub fn apply_supplement( &self, dynamic_rng: &mut impl Rng, wpos2d: Vec2<i32>, supplement: &mut ChunkSupplement, )

Trait Implementations

impl Default for Site

fn default() -> Site

Returns the “default value” for a type.