Skip to main content

Campaign

Struct Campaign 

Source
pub struct Campaign {
Show 13 fields pub world: Envelope<WorldContent>, pub npcs: Envelope<NpcsContent>, pub classes: Envelope<ClassesContent>, pub quest_plan: Envelope<QuestPlanContent>, pub quests: Envelope<QuestsContent>, pub dialogue: Envelope<DialogueContent>, pub world_edits: Option<Envelope<WorldEditsContent>>, pub geometry_brief: Option<Envelope<GeometryBriefContent>>, pub layout_graph: Option<Envelope<LayoutGraphContent>>, pub site_plan: Option<Envelope<SitePlanContent>>, pub detail_plan: Option<Envelope<DetailPlanContent>>, pub design: Option<Envelope<DesignContent>>, pub heightmap: Option<HeightmapRead>,
}
Expand description

The parsed stage documents that make up one campaign: the six required stages plus the optional stage-7 edit script (spec-0017).

Fields§

§world: Envelope<WorldContent>

Stage 1.

§npcs: Envelope<NpcsContent>

Stage 2.

§classes: Envelope<ClassesContent>

Stage 3.

§quest_plan: Envelope<QuestPlanContent>

Stage 4.

§quests: Envelope<QuestsContent>

Stage 5.

§dialogue: Envelope<DialogueContent>

Stage 6.

§world_edits: Option<Envelope<WorldEditsContent>>

Stage 7 (optional; DSL v0.6, spec-0017): the map-editor edit script. None = no world-edits.json in the campaign directory — byte-identical to a campaign from before the stage existed.

§geometry_brief: Option<Envelope<GeometryBriefContent>>

The whole map’s brief as numbers (optional; DSL v0.13, spec-0049 §4.2).

§layout_graph: Option<Envelope<LayoutGraphContent>>

The campaign’s space as a graph (optional; DSL v0.13, spec-0049 §3).

§site_plan: Option<Envelope<SitePlanContent>>

The geometric embedding of that graph (optional; DSL v0.14, spec-0049 §4).

§detail_plan: Option<Envelope<DetailPlanContent>>

Which piece fills which of the plan’s places (optional; DSL v0.15, spec-0050 §1).

§design: Option<Envelope<DesignContent>>

The approved design’s record (optional; DSL v0.22, spec-0061): the rows DW0890 holds the world’s reachable skies to. None = the campaign ships no design.json, which is a measured zero of an optional surface at validation and a refusal at staging.

§heightmap: Option<HeightmapRead>

The site plan’s heightmap as the loader read it (spec-0098 §2c), or None when nothing has read one — every campaign whose terrain is not a heightmap, and a campaign parsed from documents alone. A plan whose terrain IS a heightmap and whose image was never read is refused at validation (DW0826) rather than built over a guessed ground.

Trait Implementations§

Source§

impl Clone for Campaign

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 Campaign

Source§

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

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

impl PartialEq for Campaign

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 Campaign

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.