Struct traffloat_def::building::Def

pub struct Def {
    id: Id,
    id_str: IdString<Def>,
    name: Item,
    summary: Item,
    description: Item,
    category: Id,
    shapes: Vec<Shape>,
    hitpoint: Hitpoint,
    storage: Storage,
    features: Vec<Feature>,
}

A type of building.

Fields

id: Id

ID of the building type.

id_str: IdString<Def>

String ID of the building type.

name: Item

Name of the building type.

summary: Item

Short summary of the building type.

description: Item

Long description of the building type.

category: Id

Category of the building type.

shapes: Vec<Shape>

Shape of the building.

If multiple shapes are provided, they are all rendered together in order.

hitpoint: Hitpoint

Maximum hitpoint of a building.

The actual hitpoint is subject to asteroid and fire damage. It can be restored by construction work.

storage: Storage

Storage provided by a building

features: Vec<Feature>

Extra features associated with the building.

Implementations

impl Def

pub fn id(&self) -> Id

ID of the building type.

pub fn category(&self) -> Id

Category of the building type.

pub fn hitpoint(&self) -> Hitpoint

Maximum hitpoint of a building.

The actual hitpoint is subject to asteroid and fire damage. It can be restored by construction work.

impl Def

pub fn id_str(&self) -> &IdString<Def>

String ID of the building type.

pub fn name(&self) -> &Item

Name of the building type.

pub fn summary(&self) -> &Item

Short summary of the building type.

pub fn description(&self) -> &Item

Long description of the building type.

pub fn shapes(&self) -> &Vec<Shape>

Shape of the building.

If multiple shapes are provided, they are all rendered together in order.

pub fn storage(&self) -> &Storage

Storage provided by a building

pub fn features(&self) -> &Vec<Feature>

Extra features associated with the building.

Trait Implementations

impl Clone for Def

fn clone(&self) -> Def

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Def

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Def

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

Deserialize this value from the given Serde deserializer.

impl Identifiable<Schema> for Def

type Scope = ()

The scope of the identifier namespace.

fn id(&self) -> Id<Schema, Def>

Returns the identifier for this instance.

impl Processable<Schema> for Def

fn postprocess(&mut self, context: &mut DefaultContext) -> Result<()>

This method is called just before Xylem::convert_impl returns if #[xylem(process)] is provided.

fn preprocess(
    _from: &mut Self::From,
    _context: &mut <S as Schema>::Context
) -> Result<(), <S as Schema>::Error>

This method is called at the beginning of Xylem::convert_impl if #[xylem(process)] is provided.

impl Serialize for Def

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

Serialize this value into the given Serde serializer.

impl Xylem<Schema> for Def

type From = DefXylem

The type to convert from.

type Args = NoArgs

The args provided in the field.

fn convert_impl(
    __xylem_from: Self::From,
    __xylem_context: &mut <Schema as Schema>::Context,
    _: &Self::Args
) -> Result<Self, <Schema as Schema>::Error>

The implementation of the conversion.

fn convert(
    from: Self::From,
    context: &mut <S as Schema>::Context,
    args: &Self::Args
) -> Result<Self, <S as Schema>::Error>

Converts the From type to the Self type, registering the scope with the context. Do not override this method.