Trait Animal 

pub trait Animal: AgeableMob {
    // Required method
    fn animal_base(&self) -> &AnimalBase;

    // Provided methods
    fn in_love_time(&self) -> i32 { ... }
    fn set_in_love_time(&self, in_love: i32) { ... }
    fn love_cause_uuid(&self) -> Option<Uuid> { ... }
    fn set_love_cause_uuid(&self, love_cause: Option<Uuid>) { ... }
    fn is_in_love(&self) -> bool { ... }
    fn can_fall_in_love(&self) -> bool { ... }
    fn set_in_love(&self, player: Option<&Player>) { ... }
    fn reset_love(&self) { ... }
    fn can_mate(&self, partner: &dyn Animal) -> bool { ... }
    fn is_food(&self, _item_stack: &ItemStack) -> bool { ... }
    fn base_experience_reward_animal(&self) -> i32 { ... }
    fn ambient_sound_interval_animal(&self) -> i32 { ... }
    fn animal_walk_target_value(&self, pos: BlockPos) -> f32 { ... }
    fn is_bright_enough_to_spawn(level: &dyn LevelReader, pos: BlockPos) -> bool
       where Self: Sized { ... }
    fn check_animal_spawn_rules(
        level: &dyn LevelReader,
        spawn_reason: EntitySpawnReason,
        pos: BlockPos,
    ) -> bool
       where Self: Sized { ... }
    fn play_eating_sound(&self) { ... }
    fn mob_interact_animal(
        &self,
        player: &Player,
        hand: InteractionHand,
    ) -> InteractionResult { ... }
    fn create_breed_offspring(&self, world: &Arc<World>) -> Option<SharedEntity> { ... }
    fn breed_variant_key(&self) -> Option<&Identifier> { ... }
    fn set_breed_variant_key(&self, _key: &Identifier) -> bool { ... }
    fn initialize_breed_offspring(
        &self,
        _partner: &dyn Animal,
        _offspring: &dyn Animal,
    ) { ... }
    fn get_breed_offspring(
        &self,
        world: &Arc<World>,
        partner: &dyn Animal,
    ) -> Option<SharedEntity> { ... }
    fn spawn_child_from_breeding(
        &self,
        world: &Arc<World>,
        partner: &dyn Animal,
    ) { ... }
    fn finalize_spawn_child_from_breeding(
        &self,
        world: &Arc<World>,
        partner: &dyn Animal,
        _offspring: Option<&dyn Animal>,
    ) { ... }
    fn tick_animal_love(&self) { ... }
    fn custom_server_ai_step_animal(&self) { ... }
    fn remove_when_far_away_animal(&self, _dist_sqr: f64) -> bool { ... }
    fn save_animal(&self, nbt: &mut NbtCompound) { ... }
    fn load_animal(&self, nbt: BorrowedNbtCompoundView<'_, '_>) { ... }
}

Vanilla-shaped behavior shared by entities that extend Animal.

Required Methods

fn animal_base(&self) -> &AnimalBase

Returns shared animal runtime state.

Provided Methods

fn in_love_time(&self) -> i32

Returns vanilla Animal.inLove.

fn set_in_love_time(&self, in_love: i32)

Sets vanilla Animal.inLove.

fn love_cause_uuid(&self) -> Option<Uuid>

Returns vanilla Animal.loveCause as a persisted UUID.

fn set_love_cause_uuid(&self, love_cause: Option<Uuid>)

Sets vanilla Animal.loveCause as a persisted UUID.

fn is_in_love(&self) -> bool

Returns vanilla Animal.isInLove.

fn can_fall_in_love(&self) -> bool

Returns vanilla Animal.canFallInLove.

fn set_in_love(&self, player: Option<&Player>)

Sets vanilla love mode and records the player that caused it.

fn reset_love(&self)

Resets vanilla love mode without clearing the stored love cause.

fn can_mate(&self, partner: &dyn Animal) -> bool

Returns vanilla Animal.canMate.

fn is_food(&self, _item_stack: &ItemStack) -> bool

Returns whether the stack is valid food for this animal.

fn base_experience_reward_animal(&self) -> i32

Returns vanilla Animal.getBaseExperienceReward.

fn ambient_sound_interval_animal(&self) -> i32

Returns vanilla Animal.getAmbientSoundInterval.

fn animal_walk_target_value(&self, pos: BlockPos) -> f32

Returns vanilla Animal.getWalkTargetValue.

fn is_bright_enough_to_spawn(level: &dyn LevelReader, pos: BlockPos) -> bool

where Self: Sized,

Returns vanilla Animal.isBrightEnoughToSpawn.

fn check_animal_spawn_rules( level: &dyn LevelReader, spawn_reason: EntitySpawnReason, pos: BlockPos, ) -> bool

where Self: Sized,

Returns vanilla Animal.checkAnimalSpawnRules.

fn play_eating_sound(&self)

Plays this animal’s vanilla eating sound.

fn mob_interact_animal( &self, player: &Player, hand: InteractionHand, ) -> InteractionResult

Handles vanilla Animal.mobInteract.

fn create_breed_offspring(&self, world: &Arc<World>) -> Option<SharedEntity>

Creates a same-type offspring using the registered entity factory.

fn breed_variant_key(&self) -> Option<&Identifier>

Returns this animal’s breedable variant key when offspring inherit it.

fn set_breed_variant_key(&self, _key: &Identifier) -> bool

Applies a breedable variant key to offspring that inherit one.

fn initialize_breed_offspring( &self, _partner: &dyn Animal, _offspring: &dyn Animal, )

Applies entity-specific state to freshly created breeding offspring.

fn get_breed_offspring( &self, world: &Arc<World>, partner: &dyn Animal, ) -> Option<SharedEntity>

Creates this animal’s vanilla breeding offspring.

fn spawn_child_from_breeding(&self, world: &Arc<World>, partner: &dyn Animal)

Creates, initializes, and inserts vanilla breeding offspring.

fn finalize_spawn_child_from_breeding( &self, world: &Arc<World>, partner: &dyn Animal, _offspring: Option<&dyn Animal>, )

Applies vanilla breeding side effects after offspring creation.

fn tick_animal_love(&self)

Ticks vanilla animal love state.

fn custom_server_ai_step_animal(&self)

Runs vanilla Animal.customServerAiStep.

fn remove_when_far_away_animal(&self, _dist_sqr: f64) -> bool

Returns vanilla animal far-away despawn behavior.

fn save_animal(&self, nbt: &mut NbtCompound)

Saves vanilla animal fields.

fn load_animal(&self, nbt: BorrowedNbtCompoundView<'_, '_>)

Loads vanilla animal fields.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Animal for CowEntity

impl Animal for PigEntity