Struct veloren_common::comp::inventory::loadout_builder::LoadoutBuilder

pub struct LoadoutBuilder(Loadout);

Builder for character Loadouts, containing weapon and armour items belonging to a character, along with some helper methods for loading Item-s and ItemConfig

use veloren_common::{comp::Item, LoadoutBuilder};

// Build a loadout with character starter defaults
// and a specific sword with default sword abilities
let sword = Item::new_from_asset_expect("common.items.weapons.sword.starter");
let loadout = LoadoutBuilder::empty()
    .defaults()
    .active_mainhand(Some(sword))
    .build();

Tuple Fields

0: Loadout

Implementations

impl LoadoutBuilder

pub fn empty() -> Self

pub fn from_asset_expect( asset_specifier: &str, rng: &mut impl Rng, time: Option<&(TimeOfDay, Calendar)>, ) -> Self

Construct new LoadoutBuilder from asset_specifier Will panic if asset is broken

pub fn from_asset( asset_specifier: &str, rng: &mut impl Rng, time: Option<&(TimeOfDay, Calendar)>, ) -> Result<Self, SpecError>

Construct new LoadoutBuilder from asset_specifier

pub fn from_default(body: &Body) -> Self

Construct new default LoadoutBuilder for corresponding body

NOTE: make sure that you check what is default for this body Use it if you don’t care much about it, for example in “/spawn” command

pub fn from_loadout_spec( loadout_spec: LoadoutSpec, rng: &mut impl Rng, time: Option<&(TimeOfDay, Calendar)>, ) -> Result<Self, SpecError>

Construct new LoadoutBuilder from asset_specifier

pub fn from_loadout_spec_expect( loadout_spec: LoadoutSpec, rng: &mut impl Rng, time: Option<&(TimeOfDay, Calendar)>, ) -> Self

Construct new LoadoutBuilder from asset_specifier

Will panic if asset is broken

pub fn with_default_maintool(self, body: &Body) -> Self

Set default active mainhand weapon based on body

pub fn with_default_equipment(self, body: &Body) -> Self

Set default equipement based on body

pub fn with_preset(self, preset: Preset) -> Self

pub fn with_creator( self, creator: fn(_: LoadoutBuilder, _: Option<&SiteInformation>, time: Option<&(TimeOfDay, Calendar)>) -> LoadoutBuilder, economy: Option<&SiteInformation>, time: Option<&(TimeOfDay, Calendar)>, ) -> LoadoutBuilder

fn with_loadout_spec<R: Rng>( self, spec: LoadoutSpec, rng: &mut R, time: Option<&(TimeOfDay, Calendar)>, ) -> Result<Self, SpecError>

pub fn with_asset( self, asset_specifier: &str, rng: &mut impl Rng, time: Option<&(TimeOfDay, Calendar)>, ) -> Result<Self, SpecError>

pub fn with_asset_expect( self, asset_specifier: &str, rng: &mut impl Rng, time: Option<&(TimeOfDay, Calendar)>, ) -> Self

Usage

Creates new LoadoutBuilder with all field replaced from asset_specifier which corresponds to loadout config

Panics

1. Will panic if there is no asset with such asset_specifier
2. Will panic if path to item specified in loadout file doesn’t exist

pub fn defaults(self) -> Self

Set default armor items for the loadout. This may vary with game updates, but should be safe defaults for a new character.

fn with_equipment(self, equip_slot: EquipSlot, item: Option<Item>) -> Self

fn with_armor(self, armor_slot: ArmorSlot, item: Option<Item>) -> Self

pub fn active_mainhand(self, item: Option<Item>) -> Self

pub fn active_offhand(self, item: Option<Item>) -> Self

pub fn inactive_mainhand(self, item: Option<Item>) -> Self

pub fn inactive_offhand(self, item: Option<Item>) -> Self

pub fn shoulder(self, item: Option<Item>) -> Self

pub fn chest(self, item: Option<Item>) -> Self

pub fn belt(self, item: Option<Item>) -> Self

pub fn hands(self, item: Option<Item>) -> Self

pub fn pants(self, item: Option<Item>) -> Self

pub fn feet(self, item: Option<Item>) -> Self

pub fn back(self, item: Option<Item>) -> Self

pub fn ring1(self, item: Option<Item>) -> Self

pub fn ring2(self, item: Option<Item>) -> Self

pub fn neck(self, item: Option<Item>) -> Self

pub fn lantern(self, item: Option<Item>) -> Self

pub fn glider(self, item: Option<Item>) -> Self

pub fn head(self, item: Option<Item>) -> Self

pub fn tabard(self, item: Option<Item>) -> Self

pub fn bag(self, which: ArmorSlot, item: Option<Item>) -> Self

pub fn build(self) -> Loadout

Trait Implementations

impl Clone for LoadoutBuilder

fn clone(&self) -> LoadoutBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.