Struct DamageSource 

pub struct DamageSource {
    pub damage_type: &'static DamageType,
    pub causing_entity_id: Option<i32>,
    pub direct_entity_id: Option<i32>,
    pub source_position: Option<DVec3>,
}

Describes how an entity was damaged.

Fields

damage_type: &'static DamageType

The damage type registry entry.

causing_entity_id: Option<i32>

The entity ultimately responsible (e.g. the shooter for projectiles).

direct_entity_id: Option<i32>

The entity that directly dealt the damage (e.g. the projectile itself).

source_position: Option<DVec3>

Source position (for explosions, etc.).

Implementations

impl DamageSource

pub const fn environment(damage_type: &'static DamageType) -> Self

Environmental damage with no entity or position context (void, starvation, etc.).

pub const fn with_causing_entity(self, entity_id: i32) -> Self

Adds the entity ultimately responsible for the damage.

pub const fn with_direct_entity(self, entity_id: i32) -> Self

Adds the direct entity that delivered the damage.

pub const fn with_source_position(self, source_position: DVec3) -> Self

Adds the vanilla source position used by damage events and knockback.

pub fn bypasses_invulnerability(&self) -> bool

Whether this damage bypasses creative/spectator invulnerability.

pub fn is(&self, tag: &Identifier) -> bool

Returns whether this damage type is in the given vanilla damage-type tag.

pub fn is_direct(&self) -> bool

Returns vanilla DamageSource.isDirect.

pub const fn bypasses_cooldown(&self) -> bool

Whether this damage bypasses the invulnerability cooldown timer. No vanilla damage types currently use this, but the logic exists in LivingEntity.hurtServer(). TODO: use damage type tag query once supported

pub fn scales_with_difficulty( &self, causing_entity: Option<&dyn Entity>, ) -> bool

Whether this damage scales with world difficulty for the resolved causing entity.

causing_entity is None when the source has no cause or its stored entity ID no longer resolves. Both cases fail Vanilla’s living non-player type check.

Trait Implementations

impl Clone for DamageSource

fn clone(&self) -> DamageSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DamageSource

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

Formats the value using the given formatter.