Struct Mark 

pub struct Mark {
    pub anchor: AnchorId,
    pub offset: [i32; 3],
}

A mark (spec-0066): an anchor and an integer block offset from it, the one declaration of a point the campaign places relative to a piece.

Its cell is the anchor’s resolved cell plus offset, in world axes after the piece’s placement. It is what a body stands on (Npc::offset, Actor::offset), where a walk ends (Verb::MoveNpc, Verb::MoveActor, Verb::Teleport), where the cast ledger says a body is (CastPlace::Mark), where a sound plays (SoundAt::Anchor), and every camera position in a shot: a dolly waypoint (path), an aim target (look_at) and an anchor subject (subject). The roles are fields; the type is one.

A mark’s cell lies inside the placed piece its anchor belongs to (DW0897): an offset says where beside this place, never which place.

Fields

anchor: AnchorId

The anchor the mark is relative to.

offset: [i32; 3]

Integer [x, y, z] block offset from the anchor (default [0, 0, 0]).

Implementations

impl Mark

pub fn at(anchor: AnchorId) -> Self

A mark at anchor with no offset.

pub fn is_offset(&self) -> bool

Whether the offset is non-zero.

pub fn cell(&self, anchor_cell: [i32; 3]) -> [i32; 3]

The mark’s cell, given the cell its anchor resolved to.

pub fn display(&self) -> String

The mark as a diagnostic spells it: the anchor alone at a zero offset, else anchor + [x, y, z].

Trait Implementations

impl Clone for Mark

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 Mark

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mark

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Mark

impl Hash for Mark

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 JsonSchema for Mark

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for Mark

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Mark

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Mark

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Mark

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Mark