Struct Transitions 

pub struct Transitions { /* private fields */ }

A profile’s terrain transitions, as read and checked by the loader.

Every Transitions comes from a load, so its terrains, prototypes, layers and patterns are consistent; its parts are read through accessors.

Implementations

impl Transitions

pub fn resolve_chunk<'a, S>( &'a self, source: &'a S, layer: i32, cx: i64, cy: i64, ) -> ResolvedChunk<'a>

where S: TerrainSource + ?Sized,

Resolves the chunk at (layer, cx, cy) of source: its ground tiles, one list per profile ground layer, with the transitions applied as docs/spec/FORMAT.md section 13 defines.

It reads the chunk’s grids and the edge tiles of its eight neighbours’ terrain grids, so tiles along chunk edges agree across them. A chunk the source does not have resolves to empty tiles. The result depends only on the source’s grids and the transitions, so it is the same for every caller. A tile looks up only the transitions of its own terrain and of its neighbours’ terrains, at most MAXIMUM_TILE_TRANSITIONS, each in a table of its neighbourhoods, so the cost is linear in the chunk’s tiles however large the document.

impl Transitions

pub fn path(&self) -> &str

Source path of the document, relative to the root.

pub const fn terrain_layer(&self) -> usize

The index in the profile’s ground layers of the layer that holds painted terrain.

pub const fn ground_layers(&self) -> usize

How many ground layers the profile has: the grids a resolved chunk holds.

pub fn terrains(&self) -> &[Terrain]

Terrains from lowest to highest precedence.

pub fn transitions(&self) -> &[Transition]

Every transition, in the order they run: terrains in order, each terrain’s transitions in order.

pub fn terrain(&self, id: &str) -> Option<usize>

The index of the terrain id.

pub fn terrain_of(&self, proto: &str) -> Option<usize>

The index of the terrain proto paints, if it paints one.

pub fn protos(&self) -> impl Iterator<Item = &str> + '_

Every prototype the document names, with repeats: the terrains’ prototypes and every variant a transition may draw. Resolved tiles hold only these and the source’s own prototypes.

pub fn paint(&self, terrain: usize) -> Option<&str>

The prototype a brush writes into the terrain layer to paint the terrain at index terrain: its first.

Trait Implementations

impl Clone for Transitions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transitions

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

Formats the value using the given formatter.

impl Eq for Transitions

impl PartialEq for Transitions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Transitions