Struct EntityRegistry 

pub struct EntityRegistry {
    entries: Vec<EntityEntry>,
}

Registry for entity factories and spawn rules.

Maps EntityType to factory functions that can create entity instances. This is used when loading entities from disk or when entities are spawned.

Fields

entries: Vec<EntityEntry>

Implementations

impl EntityRegistry

fn finish_registered_load_view( entity: &SharedEntity, nbt: &BorrowedNbtCompoundView<'_, '_>, )

pub fn new() -> Self

Creates a new empty registry with entries for all entity types.

pub fn register( &mut self, entity_type: EntityTypeRef, factory: fn(EntityTypeRef, i32, DVec3, Weak<World>) -> SharedEntity, )

Registers a factory function for an entity type.

Panics

Panics if a factory is already registered for the entity type.

pub fn register_load( &mut self, entity_type: EntityTypeRef, factory: fn(EntityTypeRef, EntityBaseLoad) -> SharedEntity, )

Registers a load factory function for an entity type.

The load factory is used when loading entities from disk.

Panics

Panics if a load factory is already registered for the entity type.

pub(crate) fn register_spawn_rule( &mut self, entity_type: EntityTypeRef, rule: fn(EntityTypeRef, &dyn LevelReader, EntitySpawnReason, BlockPos, &mut dyn Rng) -> bool, )

Registers the spawn placement predicate of an entity type.

Panics

Panics if a spawn rule is already registered for the entity type.

pub(super) fn spawn_rule( &self, entity_type: EntityTypeRef, ) -> Option<fn(EntityTypeRef, &dyn LevelReader, EntitySpawnReason, BlockPos, &mut dyn Rng) -> bool>

Returns the spawn placement predicate of an entity type, if it has one.

Read it through SpawnPlacements: registered predicates are only checked against vanilla for spawner reasons.

pub fn create( &self, entity_type: EntityTypeRef, entity_id: i32, pos: DVec3, world: Weak<World>, ) -> Option<SharedEntity>

Creates a new entity instance.

Returns None if no factory is registered for the given type.

pub fn create_and_load( &self, request: EntityLoadRequest, nbt: &BorrowedNbtCompound<'_>, ) -> Option<SharedEntity>

Creates an entity from persisted data.

Returns None and logs a warning when Steel has no load factory for the type. Skipped entities and their passenger trees are not retained when the chunk is saved.

pub(crate) fn create_and_load_for_spawn_view( &self, request: EntityLoadRequest, nbt: &BorrowedNbtCompoundView<'_, '_>, ) -> Option<SharedEntity>

Creates an entity for the normal spawner path from an already borrowed NBT view.

pub fn has_factory(&self, entity_type: EntityTypeRef) -> bool

Returns whether a factory is registered for the given type.

pub fn get_implemented(&self) -> impl Iterator<Item = EntityTypeRef> + '_

Get all entity types with a registered factory.

Trait Implementations

impl Default for EntityRegistry

fn default() -> Self

Returns the “default value” for a type.