Skip to main content

Ground

Struct Ground 

Source
pub struct Ground { /* private fields */ }
Expand description

The fill, resolved: what the whole holds wherever no place claims a cell.

Implementations§

Source§

impl Ground

Source

pub fn of(c: &Campaign) -> Ground

The ground a campaign’s site plan declares.

Source

pub fn solid(block: &str) -> Ground

A solid site of block, standing alone — for a caller that has no campaign (a test, a probe).

Source

pub fn open_flat(top: i64, surface: &str, below: &str) -> Ground

An open site over one flat surface y, standing alone.

Source

pub fn is_open(&self) -> bool

True for an open site.

Source

pub fn is_declared(&self) -> bool

True when the plan declares a fill this ground answers for.

Source

pub fn top(&self, x: i64, z: i64) -> Option<i64>

The terrain’s surface y in column (x, z), on an open site whose terrain resolved. A column outside the region reads the nearest edge column, so a ring standing one cell past the region’s rim still meets the ground the rim has (DW0826 refuses a claim that leaves the region).

Source

pub fn fill_block(&self, cell: [i64; 3]) -> Option<&str>

The block the whole holds at cell where nothing — no place, no volume — claims it; None is air.

Source

pub fn ground_block(&self, cell: [i64; 3], g: i64) -> &str

The block a fixed ground cell holds (spec-0098 §2 rule 0) — a ring cell at or under its ground height g: the surface block at g, below under it on an open site; the solid fill’s block on a solid one. Volumes never reach the ring’s ground: it is the terrain continued to the plot’s edge, block for block.

Source

pub fn volume_block( &self, role: VolumeRole, cell: [i64; 3], vol_top: i64, ) -> Option<&str>

The block a volume of role is made of when it names none: the fill’s own block of that kind (spec-0098 §2b). None is air.

Source

pub fn region(&self) -> ([i64; 3], [i64; 3])

The region’s inclusive corners.

Trait Implementations§

Source§

impl Clone for Ground

Source§

fn clone(&self) -> Self

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 Debug for Ground

Source§

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

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

impl Eq for Ground

Source§

impl PartialEq for Ground

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Ground

Auto Trait Implementations§

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.