Skip to main content

Area

Struct Area 

Source
pub struct Area {
    pub id: AreaId,
    pub name: String,
    pub prefab: Option<PrefabId>,
    pub prefab_pool: Option<PoolId>,
    pub pieces: Option<Pieces>,
    pub lighting: Option<AreaLighting>,
    pub mitigation: Option<AreaMitigation>,
    pub atmosphere: Option<AtmosphereId>,
}
Expand description

One area of the world, bound to a single prefab or a jigsaw prefab pool.

An area binds exactly one of prefab (single piece) or prefab_pool (+ pieces, jigsaw multi-piece assembly, ADR-0004). The exclusivity and pool-existence rules are enforced by validation (DW0160 / DW0161); the full jigsaw layout semantics are spec-0002’s.

Fields§

§id: AreaId

Unique area id.

§name: String

Player-facing area name.

§prefab: Option<PrefabId>

The single prefab bound to this area (mutually exclusive with prefab_pool).

§prefab_pool: Option<PoolId>

The jigsaw prefab pool bound to this area (mutually exclusive with prefab); requires pieces.

§pieces: Option<Pieces>

Jigsaw piece-count bounds (only with prefab_pool).

§lighting: Option<AreaLighting>

Optional supplemental-lighting declaration (DSL v0.5, spec-0010). When present, the compiler’s relight pass guarantees min_light on every reachable walkable cell of this area by placing the declared fixture, or fails with DW0211. Absent = no relight (the area is judged as-assembled, with DW0210 if a reachable walkable cell is dark and unmitigated).

§mitigation: Option<AreaMitigation>

Optional darkness-mitigation declaration (DSL v0.6). night-vision makes the compiler emit a clocked effect give over this area’s placed bounds and is the (only) declaration that satisfies DW0210 without lighting. Independent of lighting: an area may declare both (fixtures and the effect), either, or neither.

§atmosphere: Option<AtmosphereId>

The sky this place stands under from the first tick (spec-0080 §3.2): one of world.atmospheres[], painted at world setup over the area’s placed bounds grown up and down as far as the client’s biome blend reads. The volume is the placement’s, never typed. Absent: the horizon’s biome.

Trait Implementations§

Source§

impl Clone for Area

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 Area

Source§

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

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

impl<'de> Deserialize<'de> for Area

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for Area

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl PartialEq for Area

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 Serialize for Area

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Area

Auto Trait Implementations§

§

impl Freeze for Area

§

impl RefUnwindSafe for Area

§

impl Send for Area

§

impl Sync for Area

§

impl Unpin for Area

§

impl UnsafeUnpin for Area

§

impl UnwindSafe for Area

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.