Struct veloren_common::generation::EntityConfig

pub struct EntityConfig {
    name: NameKind,
    pub body: BodyBuilder,
    pub alignment: AlignmentMark,
    pub agent: AgentConfig,
    pub loot: LootSpec<String>,
    pub inventory: InventorySpec,
    pub pets: Vec<(String, RangeInclusive<usize>)>,
    pub death_effects: Vec<DeathEffect>,
    pub meta: Vec<Meta>,
}

Struct for EntityInfo manifest.

Intended to use with .ron files as base definition or in rare cases as extension manifest. Pure data struct, doesn’t do anything until evaluated with EntityInfo.

Check assets/common/entity/template.ron or other examples.

Example

use vek::Vec3;
use veloren_common::generation::EntityInfo;

// create new EntityInfo at dummy position
// and fill it with template config
let dummy_position = Vec3::new(0.0, 0.0, 0.0);
// rng is required because some elements may be randomly generated
let mut dummy_rng = rand::thread_rng();
let entity = EntityInfo::at(dummy_position).with_asset_expect(
    "common.entity.template",
    &mut dummy_rng,
    None,
);

Fields

name: NameKind

Name of Entity Can be Name(String) with given name or Automatic which will call automatic name depend on Body or Uninit (means it should be specified somewhere in code)

body: BodyBuilder

Body Can be Exact (Body with all fields e.g BodyType, Species, Hair color and such) or RandomWith (will generate random body or species) or Uninit (means it should be specified somewhere in code)

alignment: AlignmentMark

Alignment, can be Uninit

agent: AgentConfig

Parameterises agent behaviour

loot: LootSpec<String>

Loot See LootSpec in lottery

inventory: InventorySpec

Loadout & Inventory Check docs for InventorySpec struct in this file.

pets: Vec<(String, RangeInclusive<usize>)>

Pets to spawn with this entity (specified as a list of asset paths). The range represents how many pets will be spawned.

death_effects: Vec<DeathEffect>

meta: Vec<Meta>

Meta Info for optional fields Possible fields: SkillSetAsset(String) with asset_specifier for skillset

Implementations

impl EntityConfig

pub fn from_asset_expect_owned(asset_specifier: &str) -> Self

pub fn with_body(self, body: BodyBuilder) -> Self

Trait Implementations

impl Asset for EntityConfig

type Loader = RonLoader

Specifies a way to convert raw bytes into the asset.

const EXTENSION: &'static str = "ron"

Use this field if your asset only uses one extension.

const EXTENSIONS: &'static [&'static str] = _

This field enables you to specify multiple extension for an asset.

fn default_value( id: &SharedString, error: Box<dyn Error + Send + Sync>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Specifies a eventual default value to use if an asset fails to load. If this method returns Ok, the returned value is used as an asset. In particular, if this method always returns Ok, AssetCache::load is guaranteed not to fail.

const HOT_RELOADED: bool = true

If false, disable hot-reloading for assets of this type (true by default). This avoids having to lock the asset to read it (ie it makes [Handle::read] a noop)

impl Clone for EntityConfig

fn clone(&self) -> EntityConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.