Skip to main content

BuildingDef

Struct BuildingDef 

Source
pub struct BuildingDef {
    pub id: u32,
    pub group: BuildingGroup,
    pub object_id: Option<u32>,
    pub unit_id: Option<u32>,
    pub requirements: Vec<BuildingRequirement>,
    pub build_space: Option<BuildSpace>,
    pub building_site: Option<u32>,
    pub at_objects: Vec<u32>,
    pub script: Option<String>,
}
Expand description

A single building recipe definition.

Represents one entry from a buildings*.inf file.

§.inf structure

id=N
group=...
objectid=N       (or unitid=N for units)
req=item_id,count
buildspace=...
atobject=N
buildingsite=N
script=start
    ...
script=end

Fields§

§id: u32

Unique numeric identifier for this building recipe.

§group: BuildingGroup

Category group.

§object_id: Option<u32>

Object type ID that will be created when built. Mutually exclusive with unit_id.

§unit_id: Option<u32>

Unit type ID that will be created when built. Mutually exclusive with object_id.

§requirements: Vec<BuildingRequirement>

Materials required to build this structure.

§build_space: Option<BuildSpace>

Where this building can be placed.

§building_site: Option<u32>

Object type ID of the building site (buildplace) to use.

§at_objects: Vec<u32>

Object type IDs that must exist nearby for construction.

§script: Option<String>

Optional script executed when the building is finished.

Implementations§

Source§

impl BuildingDef

Source

pub fn from_inf_fields(fields: &HashMap<String, Vec<String>>) -> Option<Self>

Construct a BuildingDef from the raw fields of a parsed .inf entry.

Unknown or unparseable fields are silently ignored; missing required fields (id) return None.

Source

pub fn with_script(self, script: Option<String>) -> Self

Attach a script to this building recipe (builder-style).

Trait Implementations§

Source§

impl Clone for BuildingDef

Source§

fn clone(&self) -> BuildingDef

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 BuildingDef

Source§

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

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

impl<'de> Deserialize<'de> for BuildingDef

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 PartialEq for BuildingDef

Source§

fn eq(&self, other: &BuildingDef) -> 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 BuildingDef

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 BuildingDef

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

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.