Struct Blueprint

pub struct Blueprint {
    pub name: String,
    pub description: String,
    pub regions: BTreeMap<Region, Vec<Entity>>,
    pub entities: BTreeMap<Entity, ComponentTypeTree>,
    pub instances: BTreeMap<Region, BTreeMap<Entity, Vec<ComponentTree>>>,
}

Blueprint of a World

Represents a World in programmable data

Fields

name: String

World’s Name

description: String

World’s Description

regions: BTreeMap<Region, Vec<Entity>>

Region names and Entities that exist in it

entities: BTreeMap<Entity, ComponentTypeTree>

Entity name and Names of its Components

instances: BTreeMap<Region, BTreeMap<Entity, Vec<ComponentTree>>>

Instances of different Entities in different Regions

Implementations

impl Blueprint

pub fn new(world_name: String, world_description: String) -> Self

pub fn preload(&mut self, regions: Vec<Region>, entities: Vec<Entity>)

Preloads Region and Entity Keys

The add_instance associated function will fail when preload is not called to preload the Region and Entity keys needed in the Instances table

pub fn add_entity(&mut self, name: Entity, component_types: ComponentTypeTree)

pub fn add_region(&mut self, name: Region, entities: Vec<Entity>)

pub fn add_instance( &mut self, region: Region, entity: Entity, component_tree: ComponentTree, ) -> Result<()>

pub fn add_default_instance( &mut self, region: Region, entity: Entity, ) -> Result<u64>

Add Instance with default values

Fetches the component tree structure from self.entities and creates an Instance with default values according to the Entity’s ComponentTypeTree

pub fn get_default_components(&self, entity: &Entity) -> Result<ComponentTree>

Return Instance with default values

Fetches the component tree structure from self.entities and creates an Instance with default values according to the Entity’s ComponentTypeTree

pub fn get_instance( &mut self, region: Region, entity: Entity, nonce: u64, ) -> Result<ComponentTree>

pub fn get_component_value( &mut self, region: Region, entity: Entity, nonce: u64, component: Component, ) -> Result<ComponentValue>

pub fn set_component_value( &mut self, region: Region, entity: Entity, nonce: u64, component: Component, value: ComponentValue, ) -> Result<()>

Trait Implementations

impl Clone for Blueprint

fn clone(&self) -> Blueprint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Blueprint

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

Formats the value using the given formatter.

impl Default for Blueprint

fn default() -> Blueprint

Returns the “default value” for a type.

impl Display for Blueprint

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

Displays the blueprint into human-readable format via a comfy CLI table

impl PartialEq for Blueprint

fn eq(&self, other: &Blueprint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Blueprint

impl StructuralPartialEq for Blueprint